Struct gregorian::YearMonth

pub struct YearMonth { /* fields omitted */ }

A month of a specific year.

Implementations

impl YearMonth

pub fn new(year: impl Into<Year>, month: Month) -> Self

Create a new year-month.

pub const fn new_const(year: Year, month: Month) -> Self

Create a new year-month at compile time.

Unline, Self::new(), this takes a Year instead of an impl Into<Year>, since the conversion can not be done in a const fn.

pub const fn year(self) -> Year

Get the year.

pub const fn month(self) -> Month

Get the month as Month.

pub const fn total_days(self) -> u8

Get the total number of days in the month.

This function accounts for leap-days, so it reports 29 days for February of leap-years, and 28 days for other years.

pub const fn day_of_year(self) -> u16

Get the day-of-year on which the month starts.

Day-of-year numbers are 1-based.

pub const fn next(self) -> Self

Get the next month as YearMonth.

After December, this function returns January of the next year.

pub const fn prev(self) -> Self

Get the previous month as YearMonth.

After January, this function returns December of the previous year.

pub const fn add_years(self, years: i16) -> Self

Get a new YearMonth by adding a number of years.

pub const fn sub_years(self, years: i16) -> Self

Get a new YearMonth by subtracting a number of years.

pub const fn add_months(self, months: i32) -> Self

Get a new YearMonth by adding a number of months.

pub const fn sub_months(self, months: i32) -> Self

Get a new YearMonth by subtracting a number of months.

pub const fn with_day(self, day: u8) -> Result<Date, InvalidDayOfMonth>

Combine the year and month with a day, to create a full Date.

pub const unsafe fn with_day_unchecked(self, day: u8) -> Date

Combine the year and month with a day, without checking for validity.

Safety

Although this is currently not the case, future implementations may rely on date validity for memory safety

pub const fn first_day(self) -> Date

Get the first day of the month as Date.

pub const fn last_day(self) -> Date

Get the last day of the month as Date.

Trait Implementations

impl Clone for YearMonth

pub fn clone(&self) -> YearMonth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for YearMonth

impl Debug for YearMonth

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

Formats the value using the given formatter.

impl Display for YearMonth

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

Formats the value using the given formatter.

impl Eq for YearMonth

impl Hash for YearMonth

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

Feeds this value into the given Hasher.

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<YearMonth> for YearMonth

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

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

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

This method tests for !=.

impl PartialOrd<YearMonth> for YearMonth

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for YearMonth

impl StructuralPartialEq for YearMonth