Struct icu::locid::Locale

pub struct Locale {
    pub id: LanguageIdentifier,
    pub extensions: Extensions,
}

A core struct representing a Unicode Locale Identifier.

A locale is made of two parts:

• Unicode Language Identifier
• A set of Unicode Extensions

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

Examples

use icu::locid::Locale;
use icu::locid::extensions::unicode::{Key, Value};

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, "en-US-u-ca-buddhist");

let key: Key = "ca".parse().expect("Parsing key failed.");
let value: Value = "buddhist".parse().expect("Parsing value failed.");
assert_eq!(loc.extensions.unicode.keywords.get(key),
    Some(&value));

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 locale 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 icu::locid::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.get(0).unwrap(), "valencia");

Fields

id: LanguageIdentifier

extensions: Extensions

Implementations

impl Locale

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

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

Examples

use icu::locid::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");

pub const fn und() -> Locale

Returns the default undefined locale “und”. Same as default(), but is const.

Examples

use icu::locid::Locale;

const loc: Locale = Locale::und();
assert_eq!(Locale::default(), loc);
assert_eq!("und", loc.to_string());

pub fn canonicalize<S>(input: S) -> Result<String, ParserError> where
    S: AsRef<[u8]>, 

This is a best-effort operation that performs all available levels of canonicalization.

At the moment the operation will normalize casing and the separator, but in the future it may also validate and update from deprecated subtags to canonical ones.

Examples

use icu::locid::Locale;

assert_eq!(Locale::canonicalize("pL_latn_pl-U-HC-H12"), Ok("pl-Latn-PL-u-hc-h12".to_string()));

Trait Implementations

impl AsMut<LanguageIdentifier> for Locale

pub fn as_mut(&mut self) -> &mut LanguageIdentifier

Performs the conversion.

impl AsRef<LanguageIdentifier> for Locale

pub fn as_ref(&self) -> &LanguageIdentifier

Performs the conversion.

impl Clone for Locale

pub fn clone(&self) -> Locale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Locale

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

Formats the value using the given formatter.

impl Default for Locale

pub fn default() -> Locale

Returns the “default value” for a type.

impl Display for Locale

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

Formats the value using the given formatter.

impl Eq for Locale

impl From<LanguageIdentifier> for Locale

pub fn from(id: LanguageIdentifier) -> Locale

Performs the conversion.

impl From<Locale> for LanguageIdentifier

pub fn from(loc: Locale) -> LanguageIdentifier

Performs the conversion.

impl FromStr for Locale

type Err = ParserError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Locale

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Locale

pub fn cmp(&self, other: &Locale) -> 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<&'_ str> for Locale

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<Locale> for Locale

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

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

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

This method tests for !=.

impl PartialEq<str> for Locale

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Locale> for Locale

pub fn partial_cmp(&self, other: &Locale) -> 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 Locale

impl StructuralPartialEq for Locale

impl Writeable for Locale

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

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

pub 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.