Struct DataMarkerInfo

#[non_exhaustive]
pub struct DataMarkerInfo {
    pub id: DataMarkerId,
    pub is_singleton: bool,
    pub has_checksum: bool,
    pub fallback_config: LocaleFallbackConfig,
}

Used for loading data from a dynamic ICU4X data provider.

A data marker is tightly coupled with the code that uses it to load data at runtime. Executables can be searched for DataMarkerInfo instances to produce optimized data files. Therefore, users should not generally create DataMarkerInfo instances; they should instead use the ones exported by a component.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: DataMarkerId

The ID of this marker.

is_singleton: bool

Whether this data marker only has a single payload, not keyed by a data identifier.

has_checksum: bool

Whether this data marker uses checksums for integrity purposes.

fallback_config: LocaleFallbackConfig

The fallback to use for this data marker.

Implementations

impl DataMarkerInfo

pub const fn from_id(id: DataMarkerId) -> Self

See Default::default

pub fn match_marker(self, marker: Self) -> Result<(), DataError>

Returns Ok if this data marker matches the argument, or the appropriate error.

Convenience method for data providers that support a single DataMarkerInfo.

Examples

use icu_provider::hello_world::*;
use icu_provider::prelude::*;

icu_provider::data_marker!(
    DummyV1,
    <HelloWorldV1 as DynamicDataMarker>::DataStruct
);

assert!(matches!(
    HelloWorldV1::INFO.match_marker(HelloWorldV1::INFO),
    Ok(())
));
assert!(matches!(
    HelloWorldV1::INFO.match_marker(DummyV1::INFO),
    Err(DataError {
        kind: DataErrorKind::MarkerNotFound,
        ..
    })
));

// The error context contains the argument:
assert_eq!(
    HelloWorldV1::INFO
        .match_marker(DummyV1::INFO)
        .unwrap_err()
        .marker,
    Some(DummyV1::INFO.id)
);

pub fn make_locale(self, locale: LocalePreferences) -> DataLocale

Constructs a DataLocale for this DataMarkerInfo.

Trait Implementations

impl Clone for DataMarkerInfo

fn clone(&self) -> DataMarkerInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataMarkerInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for DataMarkerInfo

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DataMarkerInfo

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DataMarkerInfo

fn eq(&self, other: &DataMarkerInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DataMarkerInfo

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DataMarkerInfo

impl Eq for DataMarkerInfo

impl StructuralPartialEq for DataMarkerInfo