Struct icu_locid_transform::expander::LocaleExpander
source · pub struct LocaleExpander {
likely_subtags_l: DataPayload<LikelySubtagsForLanguageV1Marker>,
likely_subtags_sr: DataPayload<LikelySubtagsForScriptRegionV1Marker>,
likely_subtags_ext: Option<DataPayload<LikelySubtagsExtendedV1Marker>>,
}
Expand description
Implements the Add Likely Subtags and Remove Likely Subtags algorithms as defined in UTS #35: Likely Subtags.
§Examples
Add likely subtags:
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
let mut locale = locale!("zh-CN");
assert_eq!(lc.maximize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("zh-Hans-CN"));
let mut locale = locale!("zh-Hant-TW");
assert_eq!(lc.maximize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("zh-Hant-TW"));
Remove likely subtags:
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
let mut locale = locale!("zh-Hans-CN");
assert_eq!(lc.minimize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("zh"));
let mut locale = locale!("zh");
assert_eq!(lc.minimize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("zh"));
Normally, only CLDR locales with Basic or higher coverage are included. To include more
locales for maximization, use try_new_extended
:
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new_extended();
let mut locale = locale!("atj");
assert_eq!(lc.maximize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("atj-Latn-CA"));
Fields§
Implementations§
source§impl LocaleExpander
impl LocaleExpander
sourcepub const fn new() -> Self
pub const fn new() -> Self
Creates a LocaleExpander
with compiled data for commonly-used locales
(locales with Basic or higher CLDR coverage).
Use this constructor if you want limited likely subtags for data-oriented use cases.
✨ Enabled with the compiled_data
Cargo feature.
sourcepub const fn new_extended() -> Self
pub const fn new_extended() -> Self
Creates a LocaleExpander
with compiled data for all locales.
Use this constructor if you want to include data for all locales, including ones that may not have data for other services (i.e. CLDR coverage below Basic).
✨ Enabled with the compiled_data
Cargo feature.
sourcepub fn try_new_extended_unstable<P>(
provider: &P,
) -> Result<LocaleExpander, LocaleTransformError>
pub fn try_new_extended_unstable<P>( provider: &P, ) -> Result<LocaleExpander, LocaleTransformError>
A version of Self::new_extended
that uses custom data provided by a DataProvider
.
sourcepub fn try_new_extended_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
) -> Result<Self, LocaleTransformError>
pub fn try_new_extended_with_any_provider( provider: &(impl AnyProvider + ?Sized), ) -> Result<Self, LocaleTransformError>
A version of Self::new_extended
that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
) -> Result<LocaleExpander, LocaleTransformError>
pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), ) -> Result<LocaleExpander, LocaleTransformError>
A version of Self::new
that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_unstable<P>(
provider: &P,
) -> Result<LocaleExpander, LocaleTransformError>
pub fn try_new_unstable<P>( provider: &P, ) -> Result<LocaleExpander, LocaleTransformError>
A version of Self::new
that uses custom data provided by a DataProvider
.
fn try_new_compat<P>( provider: &P, ) -> Result<LocaleExpander, LocaleTransformError>
fn as_borrowed(&self) -> LocaleExpanderBorrowed<'_>
sourcepub fn maximize<T: AsMut<LanguageIdentifier>>(
&self,
langid: T,
) -> TransformResult
pub fn maximize<T: AsMut<LanguageIdentifier>>( &self, langid: T, ) -> TransformResult
The maximize method potentially updates a passed in locale in place depending up the results of running the ‘Add Likely Subtags’ algorithm from https://www.unicode.org/reports/tr35/#Likely_Subtags.
If the result of running the algorithm would result in a new locale, the
locale argument is updated in place to match the result, and the method
returns TransformResult::Modified
. Otherwise, the method
returns TransformResult::Unmodified
and the locale argument is
unchanged.
This function does not guarantee that any particular set of subtags will be present in the resulting locale.
§Examples
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
let mut locale = locale!("zh-CN");
assert_eq!(lc.maximize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("zh-Hans-CN"));
let mut locale = locale!("zh-Hant-TW");
assert_eq!(lc.maximize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("zh-Hant-TW"));
If there is no data for a particular language, the result is not
modified. Note that LocaleExpander::new_extended
supports
more languages.
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
// No subtags data for ccp in the default set:
let mut locale = locale!("ccp");
assert_eq!(lc.maximize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("ccp"));
// The extended set supports it:
let lc = LocaleExpander::new_extended();
let mut locale = locale!("ccp");
assert_eq!(lc.maximize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("ccp-Cakm-BD"));
// But even the extended set does not support all language subtags:
let mut locale = locale!("mul");
assert_eq!(lc.maximize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("mul"));
sourcepub fn minimize<T: AsMut<LanguageIdentifier>>(
&self,
langid: T,
) -> TransformResult
pub fn minimize<T: AsMut<LanguageIdentifier>>( &self, langid: T, ) -> TransformResult
This returns a new Locale that is the result of running the ‘Remove Likely Subtags’ algorithm from https://www.unicode.org/reports/tr35/#Likely_Subtags.
If the result of running the algorithm would result in a new locale, the
locale argument is updated in place to match the result, and the method
returns TransformResult::Modified
. Otherwise, the method
returns TransformResult::Unmodified
and the locale argument is
unchanged.
§Examples
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
let mut locale = locale!("zh-Hans-CN");
assert_eq!(lc.minimize(&mut locale), TransformResult::Modified);
assert_eq!(locale, locale!("zh"));
let mut locale = locale!("zh");
assert_eq!(lc.minimize(&mut locale), TransformResult::Unmodified);
assert_eq!(locale, locale!("zh"));
sourcepub fn minimize_favor_script<T: AsMut<LanguageIdentifier>>(
&self,
langid: T,
) -> TransformResult
pub fn minimize_favor_script<T: AsMut<LanguageIdentifier>>( &self, langid: T, ) -> TransformResult
This returns a new Locale that is the result of running the ‘Remove Likely Subtags, favoring script’ algorithm from https://www.unicode.org/reports/tr35/#Likely_Subtags.
If the result of running the algorithm would result in a new locale, the
locale argument is updated in place to match the result, and the method
returns TransformResult::Modified
. Otherwise, the method
returns TransformResult::Unmodified
and the locale argument is
unchanged.
§Examples
use icu::locid::locale;
use icu::locid_transform::{LocaleExpander, TransformResult};
let lc = LocaleExpander::new();
let mut locale = locale!("zh_TW");
assert_eq!(
lc.minimize_favor_script(&mut locale),
TransformResult::Modified
);
assert_eq!(locale, locale!("zh_Hant"));
fn minimize_impl<T: AsMut<LanguageIdentifier>>( &self, langid: T, favor_region: bool, ) -> TransformResult
pub(crate) fn get_likely_script<T: AsRef<LanguageIdentifier>>( &self, langid: T, ) -> Option<Script>
fn infer_likely_script( &self, language: Language, region: Option<Region>, ) -> Option<Script>
Trait Implementations§
source§impl Clone for LocaleExpander
impl Clone for LocaleExpander
source§fn clone(&self) -> LocaleExpander
fn clone(&self) -> LocaleExpander
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more