Struct icu::datetime::options::components::Bag

#[non_exhaustive]
pub struct Bag {
    pub era: Option<Text>,
    pub year: Option<Year>,
    pub month: Option<Month>,
    pub week: Option<Week>,
    pub day: Option<Day>,
    pub weekday: Option<Text>,
    pub hour: Option<Numeric>,
    pub minute: Option<Numeric>,
    pub second: Option<Numeric>,
    pub fractional_second: Option<FractionalSecondDigits>,
    pub time_zone_name: Option<TimeZoneName>,
    pub preferences: Option<Bag>,
}

See the module-level docs for more information.

🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature of the icu meta-crate. Use with caution. #1317

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.

era: Option<Text>

Include the era, such as “AD” or “CE”.

year: Option<Year>

Include the year, such as “1970” or “70”.

month: Option<Month>

Include the month, such as “April” or “Apr”.

week: Option<Week>

Include the week number, such as “51st” or “51” for week 51.

day: Option<Day>

Include the day of the month/year, such as “07” or “7”.

weekday: Option<Text>

Include the weekday, such as “Wednesday” or “Wed”.

hour: Option<Numeric>

Include the hour such as “2” or “14”.

minute: Option<Numeric>

Include the minute such as “3” or “03”.

second: Option<Numeric>

Include the second such as “3” or “03”.

fractional_second: Option<FractionalSecondDigits>

Specify the number of fractional second digits such as 1 (“.3”) or 3 (“.003”).

time_zone_name: Option<TimeZoneName>

Include the time zone, such as “GMT+05:00”.

preferences: Option<Bag>

Adjust the preferences for the date, such as setting the hour cycle.

Implementations

impl Bag

pub fn empty() -> Bag

Creates an empty components bag

Has the same behavior as the Default implementation on this type.

pub fn merge(self, other: Bag) -> Bag

Merges the fields of other into self if non-None. If both fields are set, other is kept.

pub fn to_vec_fields(&self, default_hour_cycle: HourCycle) -> Vec<Field>

Converts the components::Bag into a Vec<Field>. The fields will be ordered in from most significant field to least significant. This is the order the fields are listed in the UTS 35 table - https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table

Arguments:

• default_hour_cycle specifies the hour cycle to use for the hour field if not in the Bag. preferences::Bag::hour_cycle takes precedence over this argument.

Trait Implementations

impl Clone for Bag

fn clone(&self) -> Bag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bag

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

Formats the value using the given formatter.

impl Default for Bag

fn default() -> Bag

Returns the “default value” for a type.

impl From<&DateTimePattern> for Bag

fn from(value: &DateTimePattern) -> Bag

Converts to this type from the input type.

impl From<&Pattern<'_>> for Bag

fn from(pattern: &Pattern<'_>) -> Bag

Converts to this type from the input type.

impl From<&PatternPlurals<'_>> for Bag

Get the resolved components for a FixedCalendarDateTimeFormatter, via the PatternPlurals. In the case of plurals resolve off of the required other pattern.

fn from(other: &PatternPlurals<'_>) -> Bag

Converts to this type from the input type.

impl From<Bag> for DateTimeFormatterOptions

fn from(input: Bag) -> DateTimeFormatterOptions

Converts to this type from the input type.

impl Hash for Bag

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

where __H: Hasher,

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 Bag

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

impl Eq for Bag

impl StructuralPartialEq for Bag