Struct date_time::month_tuple::MonthTuple

pub struct MonthTuple { /* fields omitted */ }

A container for a month of a specific year.

NOTE: MonthTuple's m field is one-based (one represents January) as of version 2.0.0.

Only handles values between Jan 0000 and Dec 9999 (inclusive).

Methods

impl MonthTuple

pub fn new(y: u16, m: u8) -> Result<MonthTuple, String>

Produces a new MonthTuple.

Only accepts a valid month value (1 <= m <= 12).

Only accepts a valid year value (0 <= y <= 9999).

pub fn this_month() -> MonthTuple

Returns a MonthTuple of the current month according to the system clock.

pub fn get_year(&self) -> u16

pub fn get_month(&self) -> u8

Retrieves the month component of the tuple.

Note this month is ONE-BASED (one represents January).

pub fn next_month(self) -> MonthTuple

Gets a MonthTuple representing the month immediately following the current one. Will not go past Dec 9999.

pub fn previous_month(self) -> MonthTuple

Gets a MonthTuple representing the month immediately preceding the current one. Will not go past Jan 0000.

pub fn add_months(&mut self, months: u32)

Adds a number of months to a MonthTuple.

pub fn subtract_months(&mut self, months: u32)

Subtracts a number of months from a MonthTuple.

pub fn add_years(&mut self, years: u16)

Adds a number of years to a MonthTuple.

pub fn subtract_years(&mut self, years: u16)

Subtracts a number of years from a MonthTuple.

pub fn to_readable_string(&self) -> String

Returns the month formatted to be human-readable.

Examples

• Jan 2018
• Dec 1994

Trait Implementations

impl Eq for MonthTuple

impl Copy for MonthTuple

impl PartialOrd<MonthTuple> for MonthTuple

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

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

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

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

This method tests for !=.

impl From<DateTuple> for MonthTuple

fn from(date: DateTuple) -> Self

Performs the conversion.

impl Clone for MonthTuple

fn clone(&self) -> MonthTuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for MonthTuple

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Display for MonthTuple

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

Formats the value using the given formatter.

impl Debug for MonthTuple

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

Formats the value using the given formatter.

impl FromStr for MonthTuple

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MonthTuple, Self::Err>

Parses a string s to return a value of this type.