Struct version_check::Date

pub struct Date(_);

Release date including year, month, and day.

Implementations

impl Date

pub fn read() -> Option<Date>

Reads the release date of the running compiler. If it cannot be determined (see the top-level documentation), returns None.

Example

use version_check::Date;

match Date::read() {
    Some(d) => format!("The release date is: {}", d),
    None => format!("Failed to read the release date.")
};

pub fn parse(date: &str) -> Option<Date>

Parse a release date of the form %Y-%m-%d. Returns None if date is not in %Y-%m-%d format.

Example

use version_check::Date;

let date = Date::parse("2016-04-20").unwrap();

assert!(date.at_least("2016-01-10"));
assert!(date.at_most("2016-04-20"));
assert!(date.exactly("2016-04-20"));

assert!(Date::parse("March 13, 2018").is_none());
assert!(Date::parse("1-2-3-4-5").is_none());

pub fn at_least(&self, date: &str) -> bool

Returns true if self occurs on or after date.

If date occurs before self, or if date is not in %Y-%m-%d format, returns false.

Example

use version_check::Date;

let date = Date::parse("2020-01-01").unwrap();

assert!(date.at_least("2019-12-31"));
assert!(date.at_least("2020-01-01"));
assert!(date.at_least("2014-04-31"));

assert!(!date.at_least("2020-01-02"));
assert!(!date.at_least("2024-08-18"));

pub fn at_most(&self, date: &str) -> bool

Returns true if self occurs on or before date.

If date occurs after self, or if date is not in %Y-%m-%d format, returns false.

Example

use version_check::Date;

let date = Date::parse("2020-01-01").unwrap();

assert!(date.at_most("2020-01-01"));
assert!(date.at_most("2020-01-02"));
assert!(date.at_most("2024-08-18"));

assert!(!date.at_most("2019-12-31"));
assert!(!date.at_most("2014-04-31"));

pub fn exactly(&self, date: &str) -> bool

Returns true if self occurs exactly on date.

If date is not exactly self, or if date is not in %Y-%m-%d format, returns false.

Example

use version_check::Date;

let date = Date::parse("2020-01-01").unwrap();

assert!(date.exactly("2020-01-01"));

assert!(!date.exactly("2019-12-31"));
assert!(!date.exactly("2014-04-31"));
assert!(!date.exactly("2020-01-02"));
assert!(!date.exactly("2024-08-18"));

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Date

impl Debug for Date

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

Formats the value using the given formatter.

impl Display for Date

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

Formats the value using the given formatter.

impl Eq for Date

impl Ord for Date

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

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

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

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

This method tests for !=.

impl PartialOrd<Date> 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: &Date) -> bool

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

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

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

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

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

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

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

impl StructuralEq for Date

impl StructuralPartialEq for Date