Struct gregorian::Year

pub struct Year { /* fields omitted */ }

A calendar year.

All dates in the library use the proleptic Gregorian calendar with a year 0.

Implementations

impl Year

pub const fn new(year: i16) -> Self

Create a new year from a number.

pub const fn to_number(self) -> i16

Get the year number.

pub const fn has_leap_day(self) -> bool

Check if the year has a leap day.

In the proleptic Gregorian calendar with a year 0, the year 0 has a leap day.

pub const fn total_days(self) -> u16

Get the total number of days in the year.

For leap years, this is 366. For other years, this is 365.

pub const fn next(self) -> Self

Get the next year.

pub const fn prev(self) -> Self

Get the previous year.

pub const fn with_month(self, month: Month) -> YearMonth

Combine the year with a month to create a YearMonth.

pub const fn with_day_of_year(
    self,
    day_of_year: u16
) -> Result<Date, InvalidDayOfYear>

Combine the year with a day-of-year to create a Date.

Day-of-year numbers start a 1 for January 1.

pub const fn first_month(self) -> YearMonth

Get the first month of the year as YearMonth.

pub const fn last_month(self) -> YearMonth

Get the last month of the year as YearMonth.

pub const fn months(self) -> [YearMonth; 12]

Get all months of the year as YearMonth array.

pub const fn first_day(self) -> Date

Get the first day of the year as Date.

pub const fn last_day(self) -> Date

Get the last day of the year as Date.

Trait Implementations

impl Add<i16> for Year

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: i16) -> Self

Performs the + operation.

impl AddAssign<i16> for Year

fn add_assign(&mut self, other: i16)

Performs the += operation.

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 Copy for Year

impl Debug for Year

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

Formats the value using the given formatter.

impl Display for Year

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

Formats the value using the given formatter.

impl Eq for Year

impl From<Year> for i16

fn from(other: Year) -> i16

Performs the conversion.

impl From<i16> for Year

fn from(other: i16) -> Self

Performs the conversion.

impl Hash for Year

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Year

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Year> for Year

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

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

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

This method tests for !=.

impl PartialEq<i16> for Year

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Year> 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: &Year) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i16> for Year

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Year

impl StructuralPartialEq for Year

impl Sub<i16> for Year

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: i16) -> Self

Performs the - operation.

impl SubAssign<i16> for Year

fn sub_assign(&mut self, other: i16)

Performs the -= operation.