Struct DisplayNamesOptions

#[non_exhaustive]
pub struct DisplayNamesOptions {
    pub style: Option<Style>,
    pub fallback: Fallback,
    pub language_display: LanguageDisplay,
}

A bag of options defining how region or language codes will be translated.

Example

use icu::experimental::displaynames::{
    DisplayNamesOptions, RegionDisplayNames, Style,
};
use icu::locale::{locale, subtags::region};

let locale = locale!("en-001");
let mut options: DisplayNamesOptions = Default::default();
options.style = Some(Style::Short);
let display_name = RegionDisplayNames::try_new(locale.into(), options)
    .expect("Data should load successfully");

// Full name would be "Bosnia & Herzegovina"
assert_eq!(display_name.of(region!("BA")), Some("Bosnia"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

style: Option<Style>

The optional formatting style to use for display name.

fallback: Fallback

The fallback return when the system does not have the requested display name, defaults to “code”.

language_display: LanguageDisplay

The language display kind, defaults to “dialect”.

Trait Implementations

impl Clone for DisplayNamesOptions

fn clone(&self) -> DisplayNamesOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisplayNamesOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for DisplayNamesOptions

fn default() -> DisplayNamesOptions

Returns the “default value” for a type.

impl PartialEq for DisplayNamesOptions

fn eq(&self, other: &DisplayNamesOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisplayNamesOptions

impl Eq for DisplayNamesOptions

impl StructuralPartialEq for DisplayNamesOptions