Struct icu::locid_transform::LocaleCanonicalizer
source · pub struct LocaleCanonicalizer { /* private fields */ }
Expand description
Implements the algorithm defined in UTS #35: Annex C, LocaleId Canonicalization.
Examples
use icu_locid::Locale;
use icu_locid_transform::{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§
source§impl LocaleCanonicalizer
impl LocaleCanonicalizer
sourcepub const fn new() -> LocaleCanonicalizer
pub const fn new() -> LocaleCanonicalizer
A constructor which creates a LocaleCanonicalizer
from compiled data.
✨ Enabled with the compiled_data
Cargo feature.
sourcepub fn try_new_with_any_provider(
provider: &(impl AnyProvider + ?Sized)
) -> Result<LocaleCanonicalizer, LocaleTransformError>
pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized) ) -> Result<LocaleCanonicalizer, LocaleTransformError>
A version of Self::new
that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_with_buffer_provider(
provider: &(impl BufferProvider + ?Sized)
) -> Result<LocaleCanonicalizer, LocaleTransformError>
pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized) ) -> Result<LocaleCanonicalizer, LocaleTransformError>
A version of Self::new
that uses custom data provided by a BufferProvider
.
✨ Enabled with the serde
feature.
sourcepub fn try_new_unstable<P>(
provider: &P
) -> Result<LocaleCanonicalizer, LocaleTransformError>where
P: DataProvider<AliasesV1Marker> + DataProvider<LikelySubtagsForLanguageV1Marker> + DataProvider<LikelySubtagsForScriptRegionV1Marker> + ?Sized,
pub fn try_new_unstable<P>( provider: &P ) -> Result<LocaleCanonicalizer, LocaleTransformError>where P: DataProvider<AliasesV1Marker> + DataProvider<LikelySubtagsForLanguageV1Marker> + DataProvider<LikelySubtagsForScriptRegionV1Marker> + ?Sized,
A version of Self::new
that uses custom data provided by a DataProvider
.
sourcepub const fn new_with_expander(expander: LocaleExpander) -> LocaleCanonicalizer
pub const fn new_with_expander(expander: LocaleExpander) -> LocaleCanonicalizer
Creates a LocaleCanonicalizer
with a custom LocaleExpander
and compiled data.
✨ Enabled with the compiled_data
Cargo feature.
sourcepub fn try_new_with_expander_unstable<P>(
provider: &P,
expander: LocaleExpander
) -> Result<LocaleCanonicalizer, LocaleTransformError>where
P: DataProvider<AliasesV1Marker> + ?Sized,
pub fn try_new_with_expander_unstable<P>( provider: &P, expander: LocaleExpander ) -> Result<LocaleCanonicalizer, LocaleTransformError>where P: DataProvider<AliasesV1Marker> + ?Sized,
A version of Self::new_with_expander
that uses custom data provided by a DataProvider
.
sourcepub fn try_new_with_expander_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
options: LocaleExpander
) -> Result<LocaleCanonicalizer, LocaleTransformError>
pub fn try_new_with_expander_with_any_provider( provider: &(impl AnyProvider + ?Sized), options: LocaleExpander ) -> Result<LocaleCanonicalizer, LocaleTransformError>
A version of Self::new_with_expander
that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_with_expander_with_buffer_provider(
provider: &(impl BufferProvider + ?Sized),
options: LocaleExpander
) -> Result<LocaleCanonicalizer, LocaleTransformError>
pub fn try_new_with_expander_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), options: LocaleExpander ) -> Result<LocaleCanonicalizer, LocaleTransformError>
A version of Self::new_with_expander
that uses custom data provided by a BufferProvider
.
✨ Enabled with the serde
feature.
sourcepub fn canonicalize(&self, locale: &mut Locale) -> TransformResult
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_locid::Locale;
use icu_locid_transform::{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());