Struct icu_calendar::types::FormattableYear

source ·
#[non_exhaustive]
pub struct FormattableYear { pub era: Era, pub number: i32, pub cyclic: Option<NonZeroU8>, pub related_iso: Option<i32>, }
Expand description

Representation of a formattable year.

More fields may be added in the future for things like extended year

Fields (Non-exhaustive)§

This struct is marked as 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: Era

The era containing the year.

This may not always be the canonical era for the calendar and could be an alias, for example all islamic calendars return islamic as the formattable era code which allows them to share data.

§number: i32

The year number in the current era (usually 1-based).

§cyclic: Option<NonZeroU8>

The year in the current cycle for cyclic calendars (1-indexed) can be set to None for non-cyclic calendars

For chinese and dangi it will be a number between 1 and 60, for hypothetical other calendars it may be something else.

§related_iso: Option<i32>

The related ISO year. This is normally the ISO (proleptic Gregorian) year having the greatest overlap with the calendar year. It is used in certain date formatting patterns.

Can be None if the calendar does not typically use related_iso (and CLDR does not contain patterns using it)

Implementations§

source§

impl FormattableYear

source

pub fn new(era: Era, number: i32, cyclic: Option<NonZeroU8>) -> Self

Construct a new Year given an era and number

Other fields can be set mutably after construction as needed

Trait Implementations§

source§

impl Clone for FormattableYear

source§

fn clone(&self) -> FormattableYear

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 FormattableYear

source§

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

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

impl PartialEq for FormattableYear

source§

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

source§

impl StructuralPartialEq for FormattableYear

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