Struct Language 

#[repr(transparent)]
pub struct Language(TinyAsciiStr<3>);

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

Language represents a Unicode base language code conformant to the unicode_language_subtag field of the Language and Locale Identifier, i.e. an ISO 639 value.

Examples

use icu::locale::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::locale::subtags::Language;

assert_eq!(Language::UNKNOWN.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.

Tuple Fields

0: TinyAsciiStr<3>

Implementations

impl Language

pub const fn try_from_str(s: &str) -> Result<Language, ParseError>

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

Examples

use icu_locale_core::subtags ::Language;

assert!(Language::try_from_str("en").is_ok());
assert!(Language::try_from_str("419").is_err());

pub const fn try_from_utf8(code_units: &[u8]) -> Result<Language, ParseError>

See Self::try_from_str

pub const fn try_from_raw(raw: [u8; 3]) -> Result<Language, ParseError>

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

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

Unsafely creates a Language from its raw format as returned by Self::into_raw. Unlike Self::try_from_utf8, 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.

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

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

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

A helper function for displaying as a &str.

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

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.

impl Language

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation.

If you don’t need an allocated [String], but e.g. need to write this to some sink, it is more efficient to use [Writeable] directly.

impl Language

pub const UNKNOWN: Language

The unknown language “und”.

pub const fn is_unknown(self) -> bool

Whether this Language equals Language::UNKNOWN.

Trait Implementations

impl AsULE for Language

Available on crate feature zerovec only.

type ULE = Language

The ULE type corresponding to Self.

fn to_unaligned(self) -> <Language as AsULE>::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: <Language as AsULE>::ULE) -> Language

Converts from Self::ULE to Self.

impl Clone for Language

fn clone(&self) -> Language

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Language

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

Formats the value using the given formatter.

impl Display for Language

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

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<Language> for LanguageIdentifier

Examples

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

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

fn from(language: Language) -> LanguageIdentifier

Converts to this type from the input type.

impl From<Language> for Locale

Examples

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

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

fn from(language: Language) -> Locale

Converts to this type from the input type.

impl From<Language> for TinyAsciiStr<3>

fn from(input: Language) -> TinyAsciiStr<3>

Converts to this type from the input type.

impl FromStr for Language

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Language

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NicheBytes<3> for Language

Available on crate feature zerovec only.

const NICHE_BIT_PATTERN: [u8; 3] = tinystr::TinyAsciiStr<3>::NICHE_BIT_PATTERN

impl Ord for Language

fn cmp(&self, other: &Language) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Language

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Language

fn partial_cmp(&self, other: &Language) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ULE for Language

Available on crate feature zerovec only.

fn validate_bytes(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

fn parse_bytes_to_slice(bytes: &[u8]) -> Result<&[Self], UleError>

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

unsafe fn slice_from_bytes_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_bytes_to_slice() with success.

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

Given &[Self], returns a &[u8] with the same lifetime.

impl Writeable for Language

fn write_to<W>(&self, sink: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

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.

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.

fn writeable_length_hint(&self) -> LengthHint

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

fn writeable_borrow(&self) -> Option<&str>

Returns a &str that matches the output of write_to, if possible.

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

Creates a new string with the data from this Writeable.

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

Available on crate features zerovec and alloc only.

type Container = ZeroVec<'a, Language>

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

type Slice = ZeroSlice<Language>

type GetType = Language

The type produced by Container::get()

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

impl Copy for Language

impl Eq for Language

impl StructuralPartialEq for Language