Struct icu::displaynames::displaynames::DisplayNames

pub struct DisplayNames { /* private fields */ }

Lookup of the terrritory display names by region code.

Example

use icu_displaynames::displaynames::DisplayNames;
use icu_displaynames::options::DisplayNamesOptions;
use icu_locid::locale;

let locale = locale!("en-001");
let options: DisplayNamesOptions = Default::default();
let display_name = DisplayNames::try_new_region_unstable(
    &icu_testdata::unstable(),
    &locale.into(),
    options,
)
.expect("Data should load successfully");

let region_code = "AE";
assert_eq!(display_name.of(&region_code), Some("United Arab Emirates"));

Implementations

impl DisplayNames

pub fn try_new_region_unstable<D>(
    data_provider: &D,
    locale: &DataLocale,
    options: DisplayNamesOptions
) -> Result<DisplayNames, DataError> where
    D: DataProvider<RegionDisplayNamesV1Marker> + ?Sized, 

Creates a new DisplayNames from locale data and an options bag.

📚 Help choosing a constructor

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

pub fn try_new_region_with_any_provider(
    provider: &impl AnyProvider,
    locale: &DataLocale,
    options: DisplayNamesOptions
) -> Result<DisplayNames, DataError>

Creates a new instance using an AnyProvider.

For details on the behavior of this function, see: Self::try_new_region_unstable

📚 Help choosing a constructor

pub fn try_new_region_with_buffer_provider(
    provider: &impl BufferProvider,
    locale: &DataLocale,
    options: DisplayNamesOptions
) -> Result<DisplayNames, DataError>

✨ Enabled with the "serde" feature.

Creates a new instance using a BufferProvider.

For details on the behavior of this function, see: Self::try_new_region_unstable

📚 Help choosing a constructor

pub fn of(&self, region_code: &str) -> Option<&str>

Returns the display name of the region for a given string. This function is locale-sensitive.