Struct icu_locid::subtags::Language

source ·
pub struct Language(/* private fields */);
Expand description

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

Language represents a Unicode base language code conformant 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§

source§

impl Language

source

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

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

§Examples
use icu_locid::subtags ::Language;

assert!(Language::try_from_bytes(b"en").is_ok());
assert!(Language::try_from_bytes(b"419").is_err());
source

pub const fn try_from_bytes_manual_slice( v: &[u8], start: usize, end: usize, ) -> Result<Self, ParserError>

Equivalent to try_from_bytes(bytes[start..end]), but callable in a const context (which range indexing is not).

source

pub const fn try_from_raw(v: [u8; 3]) -> Result<Self, ParserError>

Safely creates a Language from its raw format as returned by Self::into_raw. Unlike Self::try_from_bytes, this constructor only takes normalized values.

source

pub const unsafe fn from_raw_unchecked(v: [u8; 3]) -> Self

Unsafely creates a Language from its raw format as returned by Self::into_raw. Unlike Self::try_from_bytes, this constructor only takes normalized values.

§Safety

This function is safe iff Self::try_from_raw returns an Ok. This is the case for inputs that are correctly normalized.

source

pub const fn into_raw(self) -> [u8; 3]

Deconstructs into a raw format to be consumed by from_raw_unchecked or try_from_raw.

source

pub const fn as_str(&self) -> &str

A helper function for displaying as a &str.

source

pub fn strict_cmp(self, other: &[u8]) -> Ordering

Compare with BCP-47 bytes.

The return value is equivalent to what would happen if you first converted self to a BCP-47 string and then performed a byte comparison.

This function is case-sensitive and results in a total order, so it is appropriate for binary search. The only argument producing Ordering::Equal is self.as_str().as_bytes().

source

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

Compare with a potentially unnormalized BCP-47 string.

The return value is equivalent to what would happen if you first parsed the BCP-47 string and then performed a structural comparison.

source§

impl Language

source

pub const UND: Self = _

The default undefined language “und”. Same as default().

§Examples
use icu::locid::subtags::Language;

assert_eq!(Language::default(), Language::UND);
source

pub fn clear(&mut self)

Resets the Language subtag to an empty one (equal to "und").

§Examples
use icu::locid::subtags::{language, Language};

let mut lang = language!("csb");

assert_ne!(lang, Language::UND);

lang.clear();

assert_eq!(lang, Language::UND);
source

pub fn is_empty(self) -> bool

Tests if the Language subtag is empty (equal to "und").

§Examples
use icu::locid::subtags::Language;

let mut lang = Language::UND;

assert!(lang.is_empty());

lang.clear();

assert!(lang.is_empty());

Trait Implementations§

source§

impl AsULE for Language

source§

type ULE = Language

The ULE type corresponding to Self. Read more
source§

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE. Read more
source§

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self. Read more
source§

impl Clone for Language

source§

fn clone(&self) -> Language

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 Language

source§

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

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

impl Default for Language

source§

fn default() -> Language

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

impl Display for Language

This trait is implemented for compatibility with fmt!. To create a string, [Writeable::write_to_string] is usually more efficient.

source§

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

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

impl<'l> From<&'l Language> for &'l str

source§

fn from(input: &'l Language) -> Self

Converts to this type from the input type.
source§

impl From<Language> for LanguageIdentifier

§Examples

use icu::locid::{langid, subtags::language, LanguageIdentifier};

assert_eq!(LanguageIdentifier::from(language!("en")), langid!("en"));
source§

fn from(language: Language) -> Self

Converts to this type from the input type.
source§

impl From<Language> for Locale

§Examples

use icu::locid::Locale;
use icu::locid::{locale, subtags::language};

assert_eq!(Locale::from(language!("en")), locale!("en"));
source§

fn from(language: Language) -> Self

Converts to this type from the input type.
source§

impl From<Language> for TinyAsciiStr<3>

source§

fn from(input: Language) -> Self

Converts to this type from the input type.
source§

impl FromStr for Language

source§

type Err = ParserError

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

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

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

impl Hash for Language

source§

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

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 Language

source§

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

source§

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

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

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

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

impl PartialOrd for Language

source§

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

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

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

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

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

impl ULE for Language

source§

fn validate_byte_slice(bytes: &[u8]) -> Result<(), ZeroVecError>

Validates a byte slice, &[u8]. Read more
source§

fn parse_byte_slice(bytes: &[u8]) -> Result<&[Self], ZeroVecError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime. Read more
source§

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success. Read more
source§

fn as_byte_slice(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime. Read more
source§

impl Writeable for Language

source§

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

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.
source§

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink. Read more
source§

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster. Read more
source§

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>
where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.
source§

fn writeable_cmp_bytes(&self, other: &[u8]) -> Ordering

Compares the contents of this Writeable to the given bytes without allocating a String to hold the Writeable contents. Read more
source§

impl<'a> ZeroMapKV<'a> for Language

source§

type Container = ZeroVec<'a, Language>

The container that can be used with this type: ZeroVec or VarZeroVec.
source§

type Slice = ZeroSlice<Language>

source§

type GetType = Language

The type produced by Container::get() Read more
source§

type OwnedType = Language

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self() Read more
source§

impl Copy for Language

source§

impl Eq for Language

source§

impl StructuralPartialEq for Language

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

source§

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>,

source§

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>,

source§

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.
source§

impl<T> ErasedDestructor for T
where T: 'static,