Struct icu_datetime::DateTimeFormatterPreferences

#[non_exhaustive]
pub struct DateTimeFormatterPreferences {
    pub locale_prefs: LocalePreferences,
    pub numbering_system: Option<NumberingSystem>,
    pub hour_cycle: Option<HourCycle>,
    pub calendar_algorithm: Option<CalendarAlgorithm>,
}

The user locale preferences for datetime formatting.

Examples

Two ways to build a preferences bag with a custom hour cycle and calendar system:

use icu::datetime::DateTimeFormatterPreferences;
use icu::locale::Locale;
use icu::locale::preferences::extensions::unicode::keywords::CalendarAlgorithm;
use icu::locale::preferences::extensions::unicode::keywords::HourCycle;
use icu::locale::subtags::Language;

let prefs1: DateTimeFormatterPreferences = Locale::try_from_str("fr-u-ca-buddhist-hc-h12").unwrap().into();

let mut prefs2 = DateTimeFormatterPreferences::default();
prefs2.locale_prefs.language = Language::try_from_str("fr").unwrap();
prefs2.hour_cycle = Some(HourCycle::H12);
prefs2.calendar_algorithm = Some(CalendarAlgorithm::Buddhist);

assert_eq!(prefs1, prefs2);

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.

locale_prefs: LocalePreferences

Locale Preferences for the Preferences structure.

numbering_system: Option<NumberingSystem>

The user’s preferred numbering system.

Corresponds to the -u-nu in Unicode Locale Identifier.

To get the resolved numbering system, you can inspect the data provider. See the [icu_decimal::provider] module for an example.

hour_cycle: Option<HourCycle>

The user’s preferred hour cycle.

Corresponds to the -u-hc in Unicode Locale Identifier.

To get the resolved hour cycle, you can inspect the formatting pattern. See DateTimePattern for an example.

calendar_algorithm: Option<CalendarAlgorithm>

The user’s preferred calendar system

Corresponds to the -u-ca in Unicode Locale Identifier.

To get the resolved calendar system, use DateTimeFormatter::calendar_kind().

Implementations

impl DateTimeFormatterPreferences

pub fn extend(&mut self, other: DateTimeFormatterPreferences)

Extends the preferences with the values from another set of preferences.

Trait Implementations

impl Clone for DateTimeFormatterPreferences

fn clone(&self) -> DateTimeFormatterPreferences

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateTimeFormatterPreferences

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

Formats the value using the given formatter.

impl Default for DateTimeFormatterPreferences

fn default() -> DateTimeFormatterPreferences

Returns the “default value” for a type.

impl From<&DateTimeFormatterPreferences> for AnyCalendarPreferences

fn from(other: &DateTimeFormatterPreferences) -> Self

Converts to this type from the input type.

impl From<&DateTimeFormatterPreferences> for FixedDecimalFormatterPreferences

fn from(other: &DateTimeFormatterPreferences) -> Self

Converts to this type from the input type.

impl From<&LanguageIdentifier> for DateTimeFormatterPreferences

fn from(lid: &LanguageIdentifier) -> Self

Converts to this type from the input type.

impl From<&Locale> for DateTimeFormatterPreferences

fn from(loc: &Locale) -> Self

Converts to this type from the input type.

impl From<DateTimeFormatterPreferences> for Locale

fn from(other: DateTimeFormatterPreferences) -> Self

Converts to this type from the input type.

impl From<LanguageIdentifier> for DateTimeFormatterPreferences

fn from(lid: LanguageIdentifier) -> Self

Converts to this type from the input type.

impl From<Locale> for DateTimeFormatterPreferences

fn from(loc: Locale) -> Self

Converts to this type from the input type.

impl Hash for DateTimeFormatterPreferences

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DateTimeFormatterPreferences

fn eq(&self, other: &DateTimeFormatterPreferences) -> 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 DateTimeFormatterPreferences

impl Eq for DateTimeFormatterPreferences

impl StructuralPartialEq for DateTimeFormatterPreferences