Struct icu_locid::LanguageIdentifier

pub struct LanguageIdentifier {
    pub language: Language,
    pub script: Option<Script>,
    pub region: Option<Region>,
    pub variants: Variants,
}

A core struct representing a Unicode BCP47 Language Identifier.

Examples

use icu::locid::LanguageIdentifier;

let li: LanguageIdentifier = "en-US".parse()
    .expect("Failed to parse.");

assert_eq!(li.language, "en");
assert_eq!(li.script, None);
assert_eq!(li.region.unwrap(), "US");
assert_eq!(li.variants.len(), 0);
assert_eq!(li, "en-US");

Parsing

Unicode recognizes three levels of standard conformance for any language identifier:

• well-formed - syntactically correct
• valid - well-formed and only uses registered language, region, script and variant subtags…
• 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 icu::locid::LanguageIdentifier;

let li: LanguageIdentifier = "eN_latn_Us-Valencia".parse()
    .expect("Failed to parse.");

assert_eq!(li.language, "en");
assert_eq!(li.script.unwrap(), "Latn");
assert_eq!(li.region.unwrap(), "US");
assert_eq!(li.variants.get(0).unwrap(), "valencia");

Fields

language: Language

Language subtag of the language identifier.

script: Option<Script>

Script subtag of the language identifier.

region: Option<Region>

Region subtag of the language identifier.

variants: Variants

Variant subtags of the language identifier.

Implementations

impl LanguageIdentifier

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

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

Examples

use icu::locid::LanguageIdentifier;

let li = LanguageIdentifier::from_bytes(b"en-US")
    .expect("Parsing failed.");

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

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

A constructor which takes a utf8 slice which may contain extension keys, parses it and produces a well-formed LanguageIdentifier.

Examples

use icu::locid::LanguageIdentifier;

let li = LanguageIdentifier::from_locale_bytes(b"en-US-x-posix")
    .expect("Parsing failed.");

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

This method should be used for input that may be a locale identifier. All extensions will be lost.

pub const fn und() -> Self

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

Examples

use icu::locid::LanguageIdentifier;

const langid: LanguageIdentifier = LanguageIdentifier::und();
assert_eq!(LanguageIdentifier::default(), langid);
assert_eq!("und", langid.to_string());

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

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::LanguageIdentifier;

assert_eq!(LanguageIdentifier::canonicalize("pL_latn_pl"), Ok("pl-Latn-PL".to_string()));

Trait Implementations

impl AsMut<LanguageIdentifier> for LanguageIdentifier

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl AsMut<LanguageIdentifier> for Locale

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

Performs the conversion.

impl AsRef<LanguageIdentifier> for LanguageIdentifier

fn as_ref(&self) -> &Self

Performs the conversion.

impl AsRef<LanguageIdentifier> for Locale

fn as_ref(&self) -> &LanguageIdentifier

Performs the conversion.

impl Clone for LanguageIdentifier

fn clone(&self) -> LanguageIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LanguageIdentifier

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

Formats the value using the given formatter.

impl Default for LanguageIdentifier

fn default() -> LanguageIdentifier

Returns the “default value” for a type.

impl Display for LanguageIdentifier

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

Formats the value using the given formatter.

impl Eq for LanguageIdentifier

impl From<LanguageIdentifier> for Locale

fn from(id: LanguageIdentifier) -> Self

Performs the conversion.

impl From<Locale> for LanguageIdentifier

fn from(loc: Locale) -> Self

Performs the conversion.

impl FromStr for LanguageIdentifier

type Err = ParserError

The associated error which can be returned from parsing.

fn from_str(source: &str) -> Result<Self, Self::Err>

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

impl Hash for LanguageIdentifier

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

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 LanguageIdentifier

fn cmp(&self, other: &LanguageIdentifier) -> 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 LanguageIdentifier

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<LanguageIdentifier> for LanguageIdentifier

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

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

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

This method tests for !=.

impl PartialEq<str> for LanguageIdentifier

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<LanguageIdentifier> for LanguageIdentifier

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

impl StructuralPartialEq for LanguageIdentifier

impl Writeable for LanguageIdentifier

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.