Struct icu_provider::prelude::ResourceOptions

pub struct ResourceOptions {
    pub variant: Option<Cow<'static, str>>,
    pub langid: Option<LanguageIdentifier>,
}

A variant and language identifier, used for requesting data from a DataProvider.

The fields in a ResourceOptions are not generally known until runtime.

Fields

variant: Option<Cow<'static, str>>

langid: Option<LanguageIdentifier>

Implementations

impl ResourceOptions

pub fn get_components(&self) -> ResourceOptionsComponents

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

Examples

use std::borrow::Cow;
use icu_provider::prelude::*;
use icu_locid_macros::langid;

let resc_options = ResourceOptions {
    variant: Some(Cow::Borrowed("GBP")),
    langid: Some(langid!("pt_BR")),
};
let components = resc_options.get_components();

assert_eq!(
    ["GBP", "pt-BR"],
    components.iter().collect::<Vec<&str>>()[..]
);

pub fn is_empty(&self) -> bool

Returns whether this ResourceOptions has all empty fields (no components).

Trait Implementations

impl Clone for ResourceOptions

fn clone(&self) -> ResourceOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceOptions

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

Formats the value using the given formatter.

impl Default for ResourceOptions

fn default() -> Self

Returns the “default value” for a type.

impl Display for ResourceOptions

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

Formats the value using the given formatter.

impl From<LanguageIdentifier> for ResourceOptions

fn from(langid: LanguageIdentifier) -> Self

Create a ResourceOptions with the given language identifier and an empty variant field.

impl PartialEq<ResourceOptions> for ResourceOptions

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

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

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

This method tests for !=.

impl Writeable for ResourceOptions

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.

fn writeable_to_string(&self) -> String

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

impl StructuralPartialEq for ResourceOptions