Struct icu::experimental::displaynames::LocaleDisplayNamesFormatter

pub struct LocaleDisplayNamesFormatter { /* private fields */ }

Format a locale as a display string.

Example

use icu::experimental::displaynames::{
    DisplayNamesOptions, LocaleDisplayNamesFormatter,
};
use icu::locale::locale;

let locale = locale!("en-001").into();
let options: DisplayNamesOptions = Default::default();
let display_name = LocaleDisplayNamesFormatter::try_new(locale, options)
    .expect("Data should load successfully");

assert_eq!(display_name.of(&locale!("en-GB")), "British English");
assert_eq!(display_name.of(&locale!("en")), "English");
assert_eq!(display_name.of(&locale!("en-MX")), "English (Mexico)");
assert_eq!(display_name.of(&locale!("xx-YY")), "xx (YY)");
assert_eq!(display_name.of(&locale!("xx")), "xx");

Implementations

impl LocaleDisplayNamesFormatter

pub fn try_new( prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<LocaleDisplayNamesFormatter, DataError>

Creates a new LocaleDisplayNamesFormatter from locale data and an options bag using compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<LocaleDisplayNamesFormatter, DataError>

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

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<LocaleDisplayNamesFormatter, DataError>

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<D>( provider: &D, prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<LocaleDisplayNamesFormatter, DataError>

where D: DataProvider<LocaleDisplayNamesV1Marker> + DataProvider<LanguageDisplayNamesV1Marker> + DataProvider<ScriptDisplayNamesV1Marker> + DataProvider<RegionDisplayNamesV1Marker> + DataProvider<VariantDisplayNamesV1Marker> + ?Sized,

A version of Self::try_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.

pub fn of<'a, 'b, 'c>(&'b self, locale: &'c Locale) -> Cow<'a, str>

where 'b: 'a, 'c: 'a,

Returns the display name of a locale. This implementation is based on the algorithm described in https://www.unicode.org/reports/tr35/tr35-general.html#locale_display_name_algorithm