pub struct LocaleDisplayNamesFormatter { /* private fields */ }
Expand description

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§

source§

impl LocaleDisplayNamesFormatter

source

pub fn try_new( prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<Self, 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

source

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

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

📚 Help choosing a constructor

source

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

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

Enabled with the serde feature.

📚 Help choosing a constructor

source

pub fn try_new_unstable<D>( provider: &D, prefs: DisplayNamesPreferences, options: DisplayNamesOptions, ) -> Result<Self, 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.
source

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

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,