Struct icu_provider::prelude::ResourceKey

pub struct ResourceKey {
    pub category: ResourceCategory,
    pub sub_category: TinyStr16,
    pub version: u16,
}

A category, subcategory, and version, used for requesting data from a DataProvider.

The fields in a ResourceKey should generally be known at compile time.

Use resource_key! as a shortcut to create resource keys in code.

Fields

category: ResourceCategory

sub_category: TinyStr16

version: u16

Implementations

impl ResourceKey

pub fn get_components(&self) -> ResourceKeyComponents

Gets the standard path components of this ResourceKey. These components should be used when persisting the ResourceKey on the filesystem or in structured data.

Examples

use icu_provider::prelude::*;

let resc_key = icu_plurals::provider::key::CARDINAL_V1;
let components = resc_key.get_components();

assert_eq!(
    ["plurals", "cardinal@1"],
    components.iter().collect::<Vec<&str>>()[..]
);

pub fn match_key(&self, key: Self) -> Result<(), Error>

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

Convenience method for data providers that support a single ResourceKey.

Examples

use icu_provider::prelude::*;

const FOO_BAR: ResourceKey = icu_provider::resource_key!(x, "foo", "bar", 1);
const FOO_BAZ: ResourceKey = icu_provider::resource_key!(x, "foo", "baz", 1);
const BAR_BAZ: ResourceKey = icu_provider::resource_key!(x, "bar", "baz", 1);

assert!(matches!(FOO_BAR.match_key(FOO_BAR), Ok(())));
assert!(matches!(FOO_BAR.match_key(FOO_BAZ), Err(DataError::UnsupportedResourceKey(_))));
assert!(matches!(FOO_BAR.match_key(BAR_BAZ), Err(DataError::UnsupportedCategory(_))));

Trait Implementations

impl Clone for ResourceKey

fn clone(&self) -> ResourceKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ResourceKey

impl Debug for ResourceKey

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

Formats the value using the given formatter.

impl Display for ResourceKey

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

Formats the value using the given formatter.

impl Eq for ResourceKey

impl From<&'_ ResourceKey> for Error

fn from(resc_key: &ResourceKey) -> Self

Performs the conversion.

impl From<ResourceKey> for DataRequest

Create a DataRequest to a particular ResourceKey with default options.

fn from(key: ResourceKey) -> Self

Performs the conversion.

impl Ord for ResourceKey

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<ResourceKey> for ResourceKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ResourceKey> for ResourceKey

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for ResourceKey

impl StructuralPartialEq for ResourceKey

impl Writeable for ResourceKey

fn write_to<W: Write + ?Sized>(&self, sink: &mut W) -> Result

Writes bytes to the given sink. Errors from the sink are bubbled up.

fn write_len(&self) -> LengthHint

Returns a hint for the number of bytes that will be written to the sink.

pub fn writeable_to_string(&self) -> String

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.