Enum icu_datetime::fields::Year

#[repr(u8)]
pub enum Year {
    Calendar = 0,
    WeekOf = 1,
    Cyclic = 2,
    RelatedIso = 3,
}

An enum for the possible symbols of a year field in a date pattern.

Variants

Calendar = 0

Field symbol for calendar year (numeric).

In most cases the length of this field specifies the minimum number of digits to display, zero-padded as necessary. For most use cases, Year::Calendar or Year::WeekOf should be adequate.

This field symbol is represented by the character y in a date formatting pattern string.

For more details, see documentation on date field symbols.

WeekOf = 1

Field symbol for year in “week of year”.

This works for “week of year” based calendars in which the year transition occurs on a week boundary; may differ from calendar year Year::Calendar near a year transition. This numeric year designation is used in conjunction with Week::WeekOfYear, but can be used in non-Gregorian based calendar systems where week date processing is desired. The field length is interpreted in the same way as for Year::Calendar.

This field symbol is represented by the character Y in a date formatting pattern string.

For more details, see documentation on date field symbols.

Cyclic = 2

Field symbol for cyclic year; used in calendars where years are tracked in cycles, such as the Chinese or Dangi calendars.

This field symbol is represented by the character U in a date formatting pattern string.

For more details, see documentation on date field symbols.

RelatedIso = 3

Field symbol for related ISO; some calendars which use different year numbering than ISO, or no year numbering, may express years in an ISO year corresponding to a calendar year.

This field symbol is represented by the character r in a date formatting pattern string.

For more details, see documentation on date field symbols.

Implementations

impl Year

pub(crate) fn new_from_u8(value: u8) -> Option<Self>

Attempt to construct the value from its corresponding integer, returning None if not possible

impl Year

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

Retrieves an index of the field variant.

Examples

use icu::datetime::fields::Month;

assert_eq!(Month::StandAlone::idx(), 1);

Stability

This is mostly useful for serialization, and does not guarantee index stability between ICU4X versions.

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

Retrieves a field variant from an index.

Examples

use icu::datetime::fields::Month;

assert_eq!(Month::from_idx(0), Month::Format);

Stability

This is mostly useful for serialization, and does not guarantee index stability between ICU4X versions.

Trait Implementations

impl AsULE for Year

type ULE = YearULE

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

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

Converts from Self::ULE to Self.

impl Clone for Year

fn clone(&self) -> Year

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Year

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

Formats the value using the given formatter.

impl From<Year> for FieldSymbol

fn from(input: Year) -> Self

Converts to this type from the input type.

impl From<Year> for char

fn from(input: Year) -> char

Converts to this type from the input type.

impl Ord for Year

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Year

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<char> for Year

type Error = SymbolError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Yokeable<'a> for Year

where Self: Sized,

type Output = Year

This type MUST be Self with the 'static replaced with 'a, i.e. Self<'a>

fn transform(&self) -> &Self::Output

This method must cast self between &'a Self<'static> and &'a Self<'a>.

fn transform_owned(self) -> Self::Output

This method must cast self between Self<'static> and Self<'a>.

unsafe fn make(this: Self::Output) -> Self

This method can be used to cast away Self<'a>’s lifetime.

fn transform_mut<F>(&'a mut self, f: F)

where F: 'static + for<'b> FnOnce(&'b mut Self::Output),

This method must cast self between &'a mut Self<'static> and &'a mut Self<'a>, and pass it to f.

impl<'zf> ZeroFrom<'zf, Year> for Year

fn zero_from(this: &'zf Self) -> Self

Clone the other C into a struct that may retain references into C.

impl<'a> ZeroMapKV<'a> for Year

type Container = ZeroVec<'a, Year>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = ZeroSlice<Year>

type GetType = YearULE

The type produced by Container::get()

type OwnedType = Year

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl Copy for Year

impl Eq for Year

impl StructuralPartialEq for Year