Crate icu_locid

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 as language, subtags_region as 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.

Re-exports

• pub use ParserError as Error;

Modules

• extensions
  Unicode Extensions provide a mechanism to extend the LanguageIdentifier with additional bits of information - a combination of a LanguageIdentifier and Extensions is called Locale.
• subtags
  Language Identifier and Locale contains a set of subtags which represent different fields of the structure.
• zerovec
  Documentation on zero-copy deserialization of locale types.

Macros

• extensions_other_subtag
  A macro allowing for compile-time construction of valid Subtag subtags.
• extensions_private_subtag
  A macro allowing for compile-time construction of valid Subtag subtags.
• extensions_transform_key
  A macro allowing for compile-time construction of valid Key subtags.
• extensions_unicode_attribute
  A macro allowing for compile-time construction of valid Attribute subtags.
• extensions_unicode_key
  A macro allowing for compile-time construction of valid Key subtags.
• extensions_unicode_value
  A macro allowing for compile-time construction of valid Unicode Value subtag.
• langid
  A macro allowing for compile-time construction of valid LanguageIdentifiers.
• locale
  A macro allowing for compile-time construction of valid Locales.
• subtags_language
  A macro allowing for compile-time construction of valid Language subtags.
• subtags_region
  A macro allowing for compile-time construction of valid Region subtags.
• subtags_script
  A macro allowing for compile-time construction of valid Script subtags.
• subtags_variant
  A macro allowing for compile-time construction of valid Variant subtags.

Structs

• LanguageIdentifier
  A core struct representing a Unicode BCP47 Language Identifier.
• Locale
  A core struct representing a Unicode Locale Identifier.

Enums

• ParserError
  List of parser errors that can be generated while parsing LanguageIdentifier, Locale, subtags or extensions.
• SubtagOrderingResult
  The result of a subtag iterator comparison operation.