Enum gregorian::Month

#[repr(u8)]pub enum Month {
    January,
    February,
    March,
    April,
    May,
    June,
    July,
    August,
    September,
    October,
    November,
    December,
}

A month on the Gregorian calendar.

Variants

January

February

March

April

May

June

July

August

September

October

November

December

Implementations

impl Month

pub const fn new(month: u8) -> Result<Self, InvalidMonthNumber>

Create a new month from a month number.

The number must be in the range 1-12 (inclusive).

pub unsafe fn new_unchecked(month: u8) -> Self

Create a new month from a month number, without checking for validity.

Safety

The month number will be transmuted directly to Month. If the number is not a valid enum variant, this triggers undefined behaviour.

pub const fn to_number(self) -> u8

Get the month number in the range 1-12.

pub fn with_year(self, year: impl Into<Year>) -> YearMonth

Combine the month with a year to create a YearMonth.

pub const fn wrapping_add(self, count: i8) -> Self

Add a number of months, wrapping back to January after December.

pub const fn wrapping_sub(self, count: i8) -> Self

Add a number of months, wrapping back to December after January.

pub const fn wrapping_next(self) -> Self

Get the next month, wrapping back to January after December.

pub const fn wrapping_prev(self) -> Self

Get the previous month, wrapping back to December after January.

Trait Implementations

impl Clone for Month

fn clone(&self) -> Month

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Month

impl Debug for Month

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

Formats the value using the given formatter.

impl Display for Month

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

Formats the value using the given formatter.

impl Eq for Month

impl From<Month> for u8

fn from(other: Month) -> Self

Performs the conversion.

impl Hash for Month

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 Month

fn cmp(&self, other: &Month) -> 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<Month> for Month

fn eq(&self, other: &Month) -> 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 PartialEq<u8> for Month

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

fn partial_cmp(&self, other: &Month) -> 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 Month

impl StructuralPartialEq for Month

impl TryFrom<u8> for Month

type Error = InvalidMonthNumber

The type returned in the event of a conversion error.

fn try_from(other: u8) -> Result<Self, Self::Error>

Performs the conversion.