Struct icu::locid::subtags::Language

pub struct Language(_);

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

impl Language

pub fn from_bytes(v: &[u8]) -> Result<Language, 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");

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");

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

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.

pub const fn und() -> Language

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());

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.

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");

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);

Trait Implementations

impl Clone for Language

pub fn clone(&self) -> Language

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Language

impl Debug for Language

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

Formats the value using the given formatter.

impl Default for Language

pub fn default() -> Language

Returns the “default value” for a type.

impl Display for Language

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

Formats the value using the given formatter.

impl Eq for Language

impl FromStr for Language

type Err = ParserError

The associated error which can be returned from parsing.

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

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

impl Hash for Language

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 Language

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

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

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

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

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

This method tests for !=.

impl PartialOrd<Language> for Language

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

impl StructuralPartialEq for Language

impl Writeable for Language

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.