Struct unic_langid::LanguageIdentifier

pub struct LanguageIdentifier { /* fields omitted */ }

LanguageIdentifier is a core struct representing a Unicode Language Identifier.

Examples

use unic_langid_impl::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(), Some("US"));
assert_eq!(li.variants().len(), 0);

Parsing

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

• well-formed - syntactically correct
• valid - well-formed and only uses registered language subtags, extensions, keywords, types...
• 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 unic_langid_impl::LanguageIdentifier;

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

assert_eq!(li.language(), "en");
assert_eq!(li.script(), Some("Latn"));
assert_eq!(li.region(), Some("US"));
assert_eq!(li.variants().collect::<Vec<_>>(), &["valencia"]);

Methods

impl LanguageIdentifier

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

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

Examples

use unic_langid_impl::LanguageIdentifier;

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

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

pub fn from_parts<S>(
    language: Option<S>,
    script: Option<S>,
    region: Option<S>,
    variants: &[S]
) -> Result<LanguageIdentifier, LanguageIdentifierError> where
    S: AsRef<[u8]>, 

A constructor which takes optional subtags as AsRef<[u8]>, parses them and produces a well-formed LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let li = LanguageIdentifier::from_parts(Some("fr"), None, Some("CA"), &[])
    .expect("Parsing failed.");

assert_eq!(li.to_string(), "fr-CA");

pub fn into_raw_parts(
    self
) -> (Option<u64>, Option<u32>, Option<u32>, Option<Box<[u64]>>)

Consumes LanguageIdentifier and produces raw internal representations of all subtags in form of u64/u32.

Primarily used for storing internal representation and restoring via from_raw_parts_unchecked.

Examples

use unic_langid_impl::LanguageIdentifier;
use tinystr::{TinyStr8, TinyStr4};

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

let (lang, script, region, variants) = li.into_raw_parts();

let li2 = LanguageIdentifier::from_raw_parts_unchecked(
    lang.map(|l| unsafe { TinyStr8::new_unchecked(l) }),
    script.map(|s| unsafe { TinyStr4::new_unchecked(s) }),
    region.map(|r| unsafe { TinyStr4::new_unchecked(r) }),
    variants.map(|v| v.into_iter().map(|v| unsafe { TinyStr8::new_unchecked(*v) }).collect()),
);

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

pub const fn from_raw_parts_unchecked(
    language: Option<TinyStr8>,
    script: Option<TinyStr4>,
    region: Option<TinyStr4>,
    variants: Option<Box<[TinyStr8]>>
) -> LanguageIdentifier

Consumes raw representation of subtags generating new LanguageIdentifier without any checks.

Primarily used for restoring internal representation.

Examples

use unic_langid_impl::LanguageIdentifier;
use tinystr::{TinyStr8, TinyStr4};

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

let (lang, script, region, variants) = li.into_raw_parts();

let li2 =  LanguageIdentifier::from_raw_parts_unchecked(
    lang.map(|l| unsafe { TinyStr8::new_unchecked(l) }),
    script.map(|s| unsafe { TinyStr4::new_unchecked(s) }),
    region.map(|r| unsafe { TinyStr4::new_unchecked(r) }),
    variants.map(|v| v.into_iter().map(|v| unsafe { TinyStr8::new_unchecked(*v) }).collect()),
);

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

pub fn matches<O>(
    &self,
    other: &O,
    self_as_range: bool,
    other_as_range: bool
) -> bool where
    O: AsRef<LanguageIdentifier>, 

Compares a LanguageIdentifier to another AsRef<LanguageIdentifier allowing for either side to use the missing fields as wildcards.

This allows for matching between en (treated as en-*-*-*) and en-US.

Examples

use unic_langid_impl::LanguageIdentifier;

let li1: LanguageIdentifier = "en".parse()
    .expect("Parsing failed.");

let li2: LanguageIdentifier = "en-US".parse()
    .expect("Parsing failed.");

assert_ne!(li1, li2); // "en" != "en-US"
assert_ne!(li1.to_string(), li2.to_string()); // "en" != "en-US"

assert_eq!(li1.matches(&li2, false, false), false); // "en" != "en-US"
assert_eq!(li1.matches(&li2, true, false), true); // "en-*-*-*" == "en-US"
assert_eq!(li1.matches(&li2, false, true), false); // "en" != "en-*-US-*"
assert_eq!(li1.matches(&li2, true, true), true); // "en-*-*-*" == "en-*-US-*"

pub fn language(&self) -> &str

Returns the language subtag of the LanguageIdentifier.

If the language is empty, "und" is returned.

Examples

use unic_langid_impl::LanguageIdentifier;

let li1: LanguageIdentifier = "de-AT".parse()
    .expect("Parsing failed.");

assert_eq!(li1.language(), "de");

let li2: LanguageIdentifier = "und-AT".parse()
    .expect("Parsing failed.");

assert_eq!(li2.language(), "und");

pub fn set_language<S>(
    &mut self,
    language: S
) -> Result<(), LanguageIdentifierError> where
    S: AsRef<[u8]>, 

Sets the language subtag of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "de-Latn-AT".parse()
    .expect("Parsing failed.");

li.set_language("fr")
    .expect("Parsing failed.");

assert_eq!(li.to_string(), "fr-Latn-AT");

pub fn clear_language(&mut self)

Clears the language subtag of the LanguageIdentifier.

An empty language subtag is serialized to und.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "de-Latn-AT".parse()
    .expect("Parsing failed.");

li.clear_language();

assert_eq!(li.to_string(), "und-Latn-AT");

pub fn script(&self) -> Option<&str>

Returns the script subtag of the LanguageIdentifier, if set.

Examples

use unic_langid_impl::LanguageIdentifier;

let li1: LanguageIdentifier = "de-Latn-AT".parse()
    .expect("Parsing failed.");

assert_eq!(li1.script(), Some("Latn"));

let li2: LanguageIdentifier = "de-AT".parse()
    .expect("Parsing failed.");

assert_eq!(li2.script(), None);

pub fn set_script<S>(
    &mut self,
    script: S
) -> Result<(), LanguageIdentifierError> where
    S: AsRef<[u8]>, 

Sets the script subtag of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "sr-Latn".parse()
    .expect("Parsing failed.");

li.set_script("Cyrl")
    .expect("Parsing failed.");

assert_eq!(li.to_string(), "sr-Cyrl");

pub fn clear_script(&mut self)

Clears the script subtag of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "sr-Latn".parse()
    .expect("Parsing failed.");

li.clear_script();

assert_eq!(li.to_string(), "sr");

pub fn region(&self) -> Option<&str>

Returns the region subtag of the LanguageIdentifier, if set.

Examples

use unic_langid_impl::LanguageIdentifier;

let li1: LanguageIdentifier = "de-Latn-AT".parse()
    .expect("Parsing failed.");

assert_eq!(li1.region(), Some("AT"));

let li2: LanguageIdentifier = "de".parse()
    .expect("Parsing failed.");

assert_eq!(li2.region(), None);

pub fn set_region<S>(
    &mut self,
    region: S
) -> Result<(), LanguageIdentifierError> where
    S: AsRef<[u8]>, 

Sets the region subtag of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "fr-FR".parse()
    .expect("Parsing failed.");

li.set_region("CA")
    .expect("Parsing failed.");

assert_eq!(li.to_string(), "fr-CA");

pub fn clear_region(&mut self)

Clears the region subtag of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "fr-FR".parse()
    .expect("Parsing failed.");

li.clear_region();

assert_eq!(li.to_string(), "fr");

pub fn variants(&self) -> impl ExactSizeIterator

Returns a vector of variants subtags of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let li1: LanguageIdentifier = "ca-ES-valencia".parse()
    .expect("Parsing failed.");

assert_eq!(li1.variants().collect::<Vec<_>>(), &["valencia"]);

let li2: LanguageIdentifier = "de".parse()
    .expect("Parsing failed.");

assert_eq!(li2.variants().len(), 0);

pub fn set_variants<S>(
    &mut self,
    variants: impl IntoIterator<Item = S>
) -> Result<(), LanguageIdentifierError> where
    S: AsRef<[u8]>, 

Sets variant subtags of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "ca-ES".parse()
    .expect("Parsing failed.");

li.set_variants(&["valencia"])
    .expect("Parsing failed.");

assert_eq!(li.to_string(), "ca-ES-valencia");

pub fn has_variant<S>(
    &self,
    variant: S
) -> Result<bool, LanguageIdentifierError> where
    S: AsRef<[u8]>, 

Tests if a variant subtag is present in the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "ca-ES-macos".parse()
    .expect("Parsing failed.");

assert_eq!(li.has_variant("valencia"), Ok(false));
assert_eq!(li.has_variant("macos"), Ok(true));

pub fn clear_variants(&mut self)

Clears variant subtags of the LanguageIdentifier.

Examples

use unic_langid_impl::LanguageIdentifier;

let mut li: LanguageIdentifier = "ca-ES-valencia".parse()
    .expect("Parsing failed.");

li.clear_variants();

assert_eq!(li.to_string(), "ca-ES");

pub fn character_direction(&self) -> CharacterDirection

Returns character direction of the LanguageIdentifier.

Examples

use unic_langid_impl::{LanguageIdentifier, CharacterDirection};

let li1: LanguageIdentifier = "es-AR".parse()
    .expect("Parsing failed.");
let li2: LanguageIdentifier = "fa".parse()
    .expect("Parsing failed.");

assert_eq!(li1.character_direction(), CharacterDirection::LTR);
assert_eq!(li2.character_direction(), CharacterDirection::RTL);

Trait Implementations

impl AsRef<LanguageIdentifier> for LanguageIdentifier

fn as_ref(&self) -> &LanguageIdentifier

Performs the conversion.

impl Clone for LanguageIdentifier

fn clone(&self) -> LanguageIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LanguageIdentifier

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

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

Formats the value using the given formatter.

impl Eq for LanguageIdentifier

impl FromStr for LanguageIdentifier

type Err = LanguageIdentifierError

The associated error which can be returned from parsing.

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

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

impl Hash for LanguageIdentifier

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, 

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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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