icu_locid 1.4.0

API for managing Unicode Language and Locale Identifiers
Documentation

icu_locid crates.io

Parsing, manipulating, and serializing Unicode Language and Locale Identifiers.

This module is published as its own crate (icu_locid) and as part of the icu crate. See the latter for more details on the ICU4X project.

The module provides algorithms for parsing a string into a well-formed language or locale identifier as defined by UTS #35: Unicode LDML 3. Unicode Language and Locale Identifiers.

[Locale] is the most common structure to use for storing information about a language, script, region, variants and extensions. In almost all cases, this struct should be used as the base unit for all locale management operations.

[LanguageIdentifier] is a strict subset of [Locale] which can be useful in a narrow range of cases where Unicode Extensions are not relevant.

If in doubt, use [Locale].

Examples

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

let mut loc: Locale = locale!("en-US");

assert_eq!(loc.id.language, language!("en"));
assert_eq!(loc.id.script, None);
assert_eq!(loc.id.region, Some(region!("US")));
assert_eq!(loc.id.variants.len(), 0);

loc.id.region = Some(region!("GB"));

assert_eq!(loc, locale!("en-GB"));

For more details, see [Locale] and [LanguageIdentifier].

More Information

For more information on development, authorship, contributing etc. please visit ICU4X home page.