Struct date_time::date_tuple::DateTuple

pub struct DateTuple { /* private fields */ }

Holds a specific date by year, month, and day.

Handles values from 01 Jan 0000 to 31 Dec 9999.

Implementations

impl DateTuple

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

Takes a year, month, and day and converts them into a DateTuple.

Will not overlap - the date entered must be valid without further calculation.

pub fn today() -> DateTuple

Returns a DateTuple of the current date according to the system clock.

pub fn get_year(&self) -> u16

pub fn get_month(&self) -> u8

pub fn get_date(&self) -> u8

pub fn next_date(self) -> DateTuple

Gets a DateTuple representing the date immediately following the current one. Will not go past Dec 9999.

pub fn previous_date(self) -> DateTuple

Gets a DateTuple representing the date immediately preceding the current one. Will not go past 1 Jan 0000.

pub fn add_days(&mut self, days: u32)

Adds a number of days to a DateTuple.

pub fn subtract_days(&mut self, days: u32)

Subtracts a number of days from a DateTuple.

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

Adds a number of months to a DateTuple.

If the day of month is beyond the last date in the resulting month, the day of month will be set to the last day of that month.

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

Subtracts a number of months from a DateTuple.

If the day of month is beyond the last date in the resulting month, the day of month will be set to the last day of that month.

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

Adds a number of years to a DateTuple.

If the date is set to Feb 29 and the resulting year is not a leap year, it will be changed to Feb 28.

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

Subtracts a number of years from a DateTuple.

If the date is set to Feb 29 and the resulting year is not a leap year, it will be changed to Feb 28.

pub fn to_readable_string(&self) -> String

Produces a readable date.

Examples

• 2 Oct 2018
• 13 Jan 2019

Trait Implementations

impl Clone for DateTuple

fn clone(&self) -> DateTuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateTuple

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

Formats the value using the given formatter.

impl Display for DateTuple

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

Formats the value using the given formatter.

impl From<DateTuple> for MonthTuple

fn from(date: DateTuple) -> Self

Converts to this type from the input type.

impl FromStr for DateTuple

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

Expects a string formatted like 20181102.

type Err = String

The associated error which can be returned from parsing.

impl Ord for DateTuple

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DateTuple> for DateTuple

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

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

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.

impl PartialOrd<DateTuple> for DateTuple

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

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

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

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

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

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

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

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

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

impl Eq for DateTuple

impl StructuralEq for DateTuple

impl StructuralPartialEq for DateTuple