Struct icu_locale::LocaleCanonicalizer

pub struct LocaleCanonicalizer<Expander = LocaleExpander> { /* private fields */ }

Implements the algorithm defined in UTS #35: Annex C, LocaleId Canonicalization.

Examples

use icu::locale::Locale;
use icu::locale::{LocaleCanonicalizer, TransformResult};

let lc = LocaleCanonicalizer::new();

let mut locale: Locale = "ja-Latn-fonipa-hepburn-heploc".parse().unwrap();
assert_eq!(lc.canonicalize(&mut locale), TransformResult::Modified);
assert_eq!(locale, "ja-Latn-alalc97-fonipa".parse().unwrap());

Implementations

impl LocaleCanonicalizer<LocaleExpander>

pub const fn new() -> Self

A constructor which creates a LocaleCanonicalizer from compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), ) -> Result<Self, DataError>

A version of [Self :: new] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), ) -> Result<Self, DataError>

A version of [Self :: new] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<P>(provider: &P) -> Result<Self, DataError>

where P: DataProvider<AliasesV2Marker> + DataProvider<LikelySubtagsForLanguageV1Marker> + DataProvider<LikelySubtagsForScriptRegionV1Marker> + ?Sized,

A version of Self::new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

impl<Expander: AsRef<LocaleExpander>> LocaleCanonicalizer<Expander>

pub const fn new_with_expander(expander: Expander) -> Self

Creates a LocaleCanonicalizer with a custom LocaleExpander and compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_expander_unstable<P>( provider: &P, expander: Expander, ) -> Result<Self, DataError>

where P: DataProvider<AliasesV2Marker> + ?Sized,

A version of Self::new_with_expander that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn try_new_with_expander_with_any_provider( provider: &(impl AnyProvider + ?Sized), options: Expander, ) -> Result<Self, DataError>

A version of [Self :: new_with_expander] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_with_expander_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), options: Expander, ) -> Result<Self, DataError>

A version of [Self :: new_with_expander] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn canonicalize(&self, locale: &mut Locale) -> TransformResult

The canonicalize method potentially updates a passed in locale in place depending up the results of running the canonicalization algorithm from http://unicode.org/reports/tr35/#LocaleId_Canonicalization.

Some BCP47 canonicalization data is not part of the CLDR json package. Because of this, some canonicalizations are not performed, e.g. the canonicalization of und-u-ca-islamicc to und-u-ca-islamic-civil. This will be fixed in a future release once the missing data has been added to the CLDR json data. See: https://github.com/unicode-org/icu4x/issues/746

Examples

use icu::locale::{Locale, LocaleCanonicalizer, TransformResult};

let lc = LocaleCanonicalizer::new();

let mut locale: Locale = "ja-Latn-fonipa-hepburn-heploc".parse().unwrap();
assert_eq!(lc.canonicalize(&mut locale), TransformResult::Modified);
assert_eq!(locale, "ja-Latn-alalc97-fonipa".parse().unwrap());

Trait Implementations

impl<Expander: Debug> Debug for LocaleCanonicalizer<Expander>

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

Formats the value using the given formatter.

impl Default for LocaleCanonicalizer<LocaleExpander>

fn default() -> Self

Returns the “default value” for a type.