Struct Date

pub struct Date(/* private fields */);

Representation of a date in the local time zone.

Implementations

impl Date

pub fn new(year: i32, month: u32, day: u32) -> Result<Self>

Create a Date out of a year, month, and day, returning a Result.

Errors

If one of the parameters is outside the legal range for a date, returns an DateError::InvalidDate.

pub fn today() -> Self

Create a Date for today.

pub fn parse(datespec: &str) -> Result<Self>

Create a Date object from the supplied date specification.

Legal specifications include “today” and “yesterday”, the days of the week “sunday” through “saturday”, and a date in the form “YYYY-MM-DD”. The days of the week result in the date representing the previous instance of that day (last Monday for “monday”, etc.).

Errors

Return DateError::InvalidDaySpec if the supplied spec is not valid.

impl Date

pub fn year(&self) -> i32

Return the year portion of the Date

pub fn month(&self) -> u32

Return the month portion of the Date

pub fn day(&self) -> u32

Return the day portion of the Date

pub fn weekday(&self) -> Weekday

Return the day of the week enum.

pub fn weekday_str(&self) -> &'static str

Return the day of the week as a string.

impl Date

pub fn day_start(&self) -> DateTime

Create a DateTime object for the first second of the current Date

pub fn day_end(&self) -> DateTime

Create a DateTime object for the last second of the current Date

pub fn month_start(&self) -> Date

Create a Date object for the last day of the month.

pub fn month_end(&self) -> Date

Create a Date object for the last day of the month.

pub fn week_start(&self) -> Date

Create a Date object for the first day of the week.

pub fn week_end(&self) -> Date

Create a Date object for the last day of the week.

pub fn year_start(&self) -> Date

Create a Date object for the beginning of the year containing the date.

pub fn year_end(&self) -> Date

Create a Date object for the end of the year containing the date.

pub fn succ(&self) -> Date

Create a Date for the day after the current date.

pub fn pred(&self) -> Date

Create a Date for the day before the current date.

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Date

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

Formats the value using the given formatter.

impl Default for Date

fn default() -> Date

The default Date is the current day.

impl Display for Date

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

Format a Date object in “YYYY-MM-DD” format.

impl From<Date> for DateRange

fn from(date: Date) -> DateRange

Create DateRange covering the supplied date.

impl From<Date> for String

fn from(date: Date) -> Self

Convert a Date into a String

impl Ord for Date

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Date

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Date

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&str> for Date

fn try_from(date: &str) -> Result<Self>

Create a Date out of a string, returning a Result

Errors

If the date is not formatted as ‘YYYY-MM-DD’, returns an DateError::InvalidDate. Also if the date string cannot be converted into a Date, returns an DateError::InvalidDate.

type Error = DateError

The type returned in the event of a conversion error.

impl Copy for Date

impl Eq for Date

impl StructuralPartialEq for Date