Enum icu_datetime::fields::symbols::FieldSymbol

source ·
pub enum FieldSymbol {
    Era,
    Year(Year),
    Month(Month),
    Week(Week),
    Day(Day),
    Weekday(Weekday),
    DayPeriod(DayPeriod),
    Hour(Hour),
    Minute,
    Second(Second),
    TimeZone(TimeZone),
}
Expand description

A field symbol for a date formatting pattern. Field symbols are a more granular distinction for a pattern field within the category of a field type. Examples of field types are: Year, Month, Hour. Within the Hour field type, examples of field symbols are: Hour::H12, Hour::H24. Each field symbol is represented within the date formatting pattern string by a distinct character from the set of A..Z and a..z.

Variants§

§

Era

Era name.

§

Year(Year)

Year number or year name.

§

Month(Month)

Month number or month name.

§

Week(Week)

Week number or week name.

§

Day(Day)

Day number relative to a time period longer than a week (ex: month, year).

§

Weekday(Weekday)

Day number or day name relative to a week.

§

DayPeriod(DayPeriod)

Name of a period within a day.

§

Hour(Hour)

Hour number within a day, possibly with day period.

§

Minute

Minute number within an hour.

§

Second(Second)

Seconds number within a minute, including fractional seconds, or milliseconds within a day.

§

TimeZone(TimeZone)

Time zone as a name, a zone ID, or a ISO 8601 numerical offset.

Implementations§

source§

impl FieldSymbol

source

pub(crate) fn idx(&self) -> u8

Symbols are necessary components of Pattern struct which uses efficient byte serialization and deserialization via zerovec.

The FieldSymbol impl provides non-public methods that can be used to efficiently convert between u8 and the symbol variant.

The serialization model packages the variant in one byte.

  1. The top four bits are used to determine the type of the field using that type’s idx()/from_idx() for the mapping. (Examples: Year, Month, Hour)

  2. The bottom four bits are used to determine the symbol of the type. (Examples: Year::Calendar, Hour::H11)

§Diagram
┌─┬─┬─┬─┬─┬─┬─┬─┐
├─┴─┴─┴─┼─┴─┴─┴─┤
│ Type  │Symbol │
└───────┴───────┘
§Optimization

This model is optimized to package data efficiently when FieldSymbol is used as a variant of PatternItem. See the documentation of PatternItemULE for details on how it is composed.

§Constraints

This model limits the available number of possible types and symbols to 16 each.

source

pub(crate) fn from_idx(idx: u8) -> Result<Self, SymbolError>

source§

impl FieldSymbol

source

fn get_canonical_order(&self) -> u8

Skeletons are a Vec, and represent the Fields that can be used to match to a specific pattern. The order of the Vec does not affect the Pattern that is output. However, it’s more performant when matching these fields, and it’s more deterministic when serializing them to present them in a consistent order.

This ordering is taken by the order of the fields listed in the [UTS 35 Date Field Symbol Table] (https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table), and are generally ordered most significant to least significant.

Trait Implementations§

source§

impl AsULE for FieldSymbol

§

type ULE = FieldSymbolULE

The ULE type corresponding to Self. Read more
source§

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE. Read more
source§

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self. Read more
source§

impl Clone for FieldSymbol

source§

fn clone(&self) -> FieldSymbol

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FieldSymbol

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Day> for FieldSymbol

source§

fn from(input: Day) -> Self

Converts to this type from the input type.
source§

impl From<DayPeriod> for FieldSymbol

source§

fn from(input: DayPeriod) -> Self

Converts to this type from the input type.
source§

impl From<FieldSymbol> for char

source§

fn from(symbol: FieldSymbol) -> Self

Converts to this type from the input type.
source§

impl From<Hour> for FieldSymbol

source§

fn from(input: Hour) -> Self

Converts to this type from the input type.
source§

impl From<Month> for FieldSymbol

source§

fn from(input: Month) -> Self

Converts to this type from the input type.
source§

impl From<Second> for FieldSymbol

source§

fn from(input: Second) -> Self

Converts to this type from the input type.
source§

impl From<TimeZone> for FieldSymbol

source§

fn from(input: TimeZone) -> Self

Converts to this type from the input type.
source§

impl From<Week> for FieldSymbol

source§

fn from(input: Week) -> Self

Converts to this type from the input type.
source§

impl From<Weekday> for FieldSymbol

source§

fn from(input: Weekday) -> Self

Converts to this type from the input type.
source§

impl From<Year> for FieldSymbol

source§

fn from(input: Year) -> Self

Converts to this type from the input type.
source§

impl Ord for FieldSymbol

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for FieldSymbol

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for FieldSymbol

source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl TryFrom<char> for FieldSymbol

§

type Error = SymbolError

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

fn try_from(ch: char) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for FieldSymbol

source§

impl Eq for FieldSymbol

source§

impl StructuralPartialEq for FieldSymbol

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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.
source§

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

source§

impl<T> MaybeSendSync for T