Struct unic_locale::Locale

source ·
pub struct Locale {
    pub id: LanguageIdentifier,
    pub extensions: ExtensionsMap,
}
Expand description

Locale is a core struct representing a Unicode Locale Identifier.

A locale is made of two parts:

  • id - Unicode Language Identifier
  • extensions - A set of Unicode Extensions

Locale exposes all of the same methods as LanguageIdentifier, and on top of that is able to parse, manipulate and serialize unicode extension fields.

§Examples

use unic_locale_impl::Locale;

let loc: Locale = "en-US-u-ca-buddhist".parse()
    .expect("Failed to parse.");

assert_eq!(loc.id.language, "en");
assert_eq!(loc.id.script, None);
assert_eq!(loc.id.region, Some("US".parse().unwrap()));
assert_eq!(loc.id.variants().len(), 0);
assert_eq!(loc.extensions.unicode.keyword("ca")
    .expect("Getting keyword failed.")
    .collect::<Vec<_>>(),
    &["buddhist"]);

§Parsing

Unicode recognizes three levels of standard conformance for a locale:

  • well-formed - syntactically correct
  • valid - well-formed and only uses registered language subtags, extensions, keywords, types…
  • canonical - valid and no deprecated codes or structure.

At the moment parsing normalizes a well-formed language identifier converting _ separators to - and adjusting casing to conform to the Unicode standard.

Any bogus subtags will cause the parsing to fail with an error. No subtag validation is performed.

§Examples:

use unic_locale_impl::Locale;

let loc: Locale = "eN_latn_Us-Valencia_u-hC-H12".parse()
    .expect("Failed to parse.");

assert_eq!(loc.id.language, "en");
assert_eq!(loc.id.script, Some("Latn".parse().unwrap()));
assert_eq!(loc.id.region, Some("US".parse().unwrap()));
assert_eq!(loc.id.variants().collect::<Vec<_>>(), &["valencia"]);

Fields§

§id: LanguageIdentifier§extensions: ExtensionsMap

Implementations§

source§

impl Locale

source

pub fn from_bytes(v: &[u8]) -> Result<Locale, LocaleError>

A constructor which takes a utf8 slice, parses it and produces a well-formed Locale.

§Examples
use unic_locale_impl::Locale;

let loc = Locale::from_bytes("en-US-u-hc-h12".as_bytes())
    .expect("Parsing failed.");

assert_eq!(loc.to_string(), "en-US-u-hc-h12");
source

pub fn from_parts( language: Language, script: Option<Script>, region: Option<Region>, variants: &[Variant], extensions: Option<ExtensionsMap> ) -> Locale

A constructor which takes optional subtags as AsRef<[u8]>, parses them and produces a well-formed Locale.

§Examples
use unic_locale_impl::Locale;

let loc = Locale::from_parts("fr".parse().unwrap(), None, Some("CA".parse().unwrap()), &[], None);

assert_eq!(loc.to_string(), "fr-CA");
source

pub const unsafe fn from_raw_parts_unchecked( language: Language, script: Option<Script>, region: Option<Region>, variants: Option<Box<[Variant]>>, extensions: ExtensionsMap ) -> Locale

§Safety

This function accepts subtags expecting variants to be deduplicated and ordered.

source

pub fn into_parts( self ) -> (Language, Option<Script>, Option<Region>, Vec<Variant>, String)

Consumes Locale and produces raw internal representations of all subtags in form of u64/u32.

Primarily used for storing internal representation and restoring via from_raw_parts_unchecked.

§Examples
use unic_locale_impl::Locale;
use tinystr::{TinyStr8, TinyStr4};

let loc: Locale = "en-US".parse()
    .expect("Parsing failed.");

let (lang, script, region, variants, extensions) = loc.into_parts();

let loc2 = Locale::from_parts(
    lang,
    script,
    region,
    &variants,
    Some(extensions.parse().unwrap())
);

assert_eq!(loc2.to_string(), "en-US");
source

pub fn matches<O>( &self, other: &O, self_as_range: bool, other_as_range: bool ) -> bool
where O: AsRef<Locale>,

Compares a Locale to another AsRef<Locale allowing for either side to use the missing fields as wildcards.

This allows for matching between en (treated as en-*-*-*) and en-US.

§Examples
use unic_locale_impl::Locale;

let loc1: Locale = "en".parse()
    .expect("Parsing failed.");

let loc2: Locale = "en-US".parse()
    .expect("Parsing failed.");

assert_ne!(loc1, loc2); // "en" != "en-US"
assert_ne!(loc1.to_string(), loc2.to_string()); // "en" != "en-US"

assert_eq!(loc1.matches(&loc2, false, false), false); // "en" != "en-US"
assert_eq!(loc1.matches(&loc2, true, false), true); // "en-*-*-*" == "en-US"
assert_eq!(loc1.matches(&loc2, false, true), false); // "en" != "en-*-US-*"
assert_eq!(loc1.matches(&loc2, true, true), true); // "en-*-*-*" == "en-*-US-*"

Trait Implementations§

source§

impl AsRef<LanguageIdentifier> for Locale

source§

fn as_ref(&self) -> &LanguageIdentifier

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Locale> for Locale

source§

fn as_ref(&self) -> &Locale

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Locale

source§

fn clone(&self) -> Locale

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Locale

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Locale

source§

fn default() -> Locale

Returns the “default value” for a type. Read more
source§

impl Display for Locale

source§

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

Formats the value using the given formatter. Read more
source§

impl From<LanguageIdentifier> for Locale

source§

fn from(id: LanguageIdentifier) -> Locale

Converts to this type from the input type.
source§

impl From<Locale> for LanguageIdentifier

source§

fn from(value: Locale) -> LanguageIdentifier

Converts to this type from the input type.
source§

impl FromStr for Locale

§

type Err = LocaleError

The associated error which can be returned from parsing.
source§

fn from_str(source: &str) -> Result<Locale, <Locale as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for Locale

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Locale

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Locale

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Locale

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Eq for Locale

source§

impl StructuralPartialEq for Locale

Auto Trait Implementations§

§

impl Freeze for Locale

§

impl RefUnwindSafe for Locale

§

impl Send for Locale

§

impl Sync for Locale

§

impl Unpin for Locale

§

impl UnwindSafe for Locale

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.