Struct Date

pub struct Date { /* private fields */ }

SAC13 date.

Consists of the three components year, month and day. Check the module root documentation for details about the SAC13 calendar and its dates. You can also check out the documentation for Year and Month.

Examples

use sac13::prelude::*;

// Hard-coded values can be constructed with a compile-time checked macro.
let date = date!(M024 - 03 - 12);

Implementations

impl Date

pub const fn from_ymd(year: Year, month: Month, day: u8) -> Option<Self>

SAC13 date from given year, month, day.

Returns None for invalid dates.

Examples

use sac13::prelude::*;

let y = Year::new(12020).unwrap();
let m = Month::new(5).unwrap();

let date = Date::from_ymd(y,m,16).unwrap();

pub const fn from_ymd_untyped(year: u16, month: u8, day: u8) -> Option<Self>

Like from_ymd() but from integers instead of typed Year and Month.

Returns None for invalid dates.

Examples

use sac13::{Date,date};

assert_eq!(Date::from_ymd_untyped(12020,02,16), Some(date!(M020 - 02 - 16)));
assert_eq!(Date::from_ymd_untyped(12020,02,29), None); // April 29th does not exist in SAC13

pub const fn year(&self) -> Year

Year component of the date.

pub const fn month(&self) -> Month

Month component of the date.

pub const fn day(&self) -> u8

Day component of the date.

pub const fn weekday_ordinal(&self) -> u8

SAC13 Weekday ordinal.

Returns which day of the week it is. Typically 1-7, 8 on synchronization days. Note that 1-7 are NOT synonymous with Monday - Sunday. SAC13 doesn’t have weekdays in the typical sense.

pub const fn month_len(year: Year, month: Month) -> u8

All months have 28 days, except (Addenduary)Month::Addenduary, and (August)Month::August on leap years, which are 29 days long.

Trait Implementations

impl CalendarDate for Date

const MIN: Self

Earliest representable date.

const MAX: Self

Latest representable date.

fn as_julian(&self) -> i32

Convert the date into the corresponding Julian Day Number.

fn from_julian(value: i32) -> Option<Self>

Get the date from the corresponding Julian

fn tomorrow(self) -> Option<Self>

fn yesterday(self) -> Option<Self>

fn convert<T: CalendarDate>(self) -> T

Converts the calendar date to a different calendar system.

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 Display for Date

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

Displays the SAC13 date.

use sac13::date;

let formatted_date = format!("{}", date!(M020 - 05 - 21));
assert_eq!(formatted_date, "M020-05-21");

impl Hash for Date

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

impl Eq for Date

impl StructuralPartialEq for Date