Struct icu_locid::subtags::Language[−][src]

pub struct Language(_);

Expand description

A language subtag (examples: "en", "csb", "zh", "und", etc.)

Language represents a Unicode base language code conformat to the unicode_language_id field of the Language and Locale Identifier.

Examples

use icu::locid::subtags::Language;

let language: Language = "en".parse()
    .expect("Failed to parse a language subtag.");

If the Language has no value assigned, it serializes to a string "und", which can be then parsed back to an empty Language field.

Examples

use icu::locid::subtags::Language;

assert_eq!(Language::default().as_str(), "und");

Notice: ICU4X uses a narrow form of language subtag of 2-3 characters. The specification allows language subtag to optionally also be 5-8 characters but that form has not been used and ICU4X does not support it right now.

Implementations

[src]

impl Language

[src]

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

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

Examples

use icu::locid::subtags::Language;

let lang = Language::from_bytes(b"en")
    .expect("Parsing failed.");

assert_eq!(lang, "en");

[src]

pub fn into_raw(self) -> Option<u32>

Deconstructs the Language into raw format to be consumed by from_raw_unchecked().

Examples

use icu::locid::subtags::Language;

let lang = Language::from_bytes(b"en")
    .expect("Parsing failed.");

let raw = lang.into_raw();
let lang = unsafe { Language::from_raw_unchecked(raw) };
assert_eq!(lang, "en");

[src]

pub const unsafe fn from_raw_unchecked(v: Option<u32>) -> Self

Constructor which takes a raw value returned by into_raw().

Examples

use icu::locid::subtags::Language;

let lang = Language::from_bytes(b"en")
    .expect("Parsing failed.");

let raw = lang.into_raw();
let lang = unsafe { Language::from_raw_unchecked(raw) };
assert_eq!(lang, "en");

Safety

This function accepts a u32 that is expected to be a valid TinyStr4 representing a Language subtag in canonical syntax.

[src]

pub const fn und() -> Self

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

Examples

use icu::locid::subtags::Language;

const language: Language = Language::und();
assert_eq!(Language::default(), language);
assert_eq!("und", language.to_string());

[src]

pub fn as_str(&self) -> &str

A helper function for displaying a Language subtag as a &str.

Examples

use icu::locid::subtags::Language;

let lang = Language::from_bytes(b"en")
    .expect("Parsing failed.");

assert_eq!(lang.as_str(), "en");

Notice: For many use cases, such as comparison, Language implements PartialEq<&str> which allows for direct comparisons.

[src]

pub fn clear(&mut self)

Resets the Language subtag to an empty one.

Examples

use icu::locid::subtags::Language;

let mut lang: Language = "csb".parse()
    .expect("Parsing failed.");

assert_eq!(lang.as_str(), "csb");

lang.clear();

assert_eq!(lang.as_str(), "und");

[src]

pub fn is_empty(self) -> bool

Tests if the Language subtag is empty.

Examples

use icu::locid::subtags::Language;

let mut lang: Language = "und".parse()
    .expect("Parsing failed.");

assert_eq!(lang.is_empty(), true);

lang.clear();

assert_eq!(lang.is_empty(), true);