Module icu::locid

source · []
Expand description

Language and Locale operations

This API provides necessary functionality for parsing, manipulating, and serializing Unicode Language and Locale Identifiers.

The crate 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::{language, locale, region};

let mut loc = locale!("en-US").clone();

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

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

assert_eq!(loc.to_string(), "en-GB");

For more details, see Locale and LanguageIdentifier.

Modules

Unicode Extensions provide a mechanism to extend the LanguageIdentifier with additional bits of information - a combination of a LanguageIdentifier and Extensions is called Locale.

Language Identifier and Locale contains a set of subtags which represent different fields of the structure.

Documentation on zero-copy deserialization of locale types.

Macros

A macro allowing for compile-time construction of valid LanguageIdentifiers.

A macro allowing for compile-time construction of valid Language subtag.

A macro allowing for compile-time construction of valid Locales.

A macro allowing for compile-time construction of valid Region subtag.

A macro allowing for compile-time construction of valid Script subtag.

A macro allowing for compile-time construction of valid Transform Key subtag.

A macro allowing for compile-time construction of valid Unicode Key subtag.

A macro allowing for compile-time construction of valid Unicode Value subtag.

A macro allowing for compile-time construction of valid Variant subtag.

Structs

A core struct representing a Unicode Locale Identifier.

Enums

List of parser errors that can be generated while parsing LanguageIdentifier, Locale, subtags or extensions.