Struct DateTime

pub struct DateTime(pub Date, pub Time);

Date & Time

Tuple Fields

0: Date

1: Time

Implementations

impl DateTime

pub const fn try_parse(from: &str) -> Result<Self, ParseError>

Try to parse Date and Time separated by space or T

May also accept dates with too much or too little 0-padding for the year. Month, day, hour, minute and second segments must be exactly 2 digits.

Note that unlike the ymd_hms! macro (which only works on literals), this function (because it uses Time::try_parse) also allows for the seconds to be omitted. So this function accepts hh:mm Time components as well as hh:mm:ss.

 use greg::calendar::DateTime;
 use greg::ymd_hms;

 assert_eq!(
     DateTime::try_parse("2022-01-01 00:00:00"),
     Ok(ymd_hms!(2022-01-01 00:00:00))
 );
 assert_eq!(
     DateTime::try_parse("2020-06-06 10:15"),
     Ok(ymd_hms!(2020-06-06 10:15:00))
 );
 assert_eq!(
     DateTime::try_parse("1234-01-23T12:34:56"),
     Ok(ymd_hms!(1234-01-23 12:34:56))
 );

 use greg::calendar::ParseError;

 assert_eq!(
     DateTime::try_parse("2021-01-01"),
     Err(ParseError::Format)
 );
 assert_eq!(
     DateTime::try_parse("09:30:00"),
     Err(ParseError::Format)
 );
 // no leap seconds
 assert!(DateTime::try_parse("2016-12-31 23:59:60").is_err());
 assert!(DateTime::try_parse("Jan 1st, 2020 2pm").is_err());

pub const fn parse(from: &str) -> Self

Parse Date and Time and panic if invalid

Just a convenient wrapper around try_parse (since there’s no .unwrap() in const).

 use greg::calendar::DateTime;
 const NYE: DateTime = DateTime::parse("2023-12-31 23:59:59");

 assert_eq!(
     DateTime::parse("2023-08-17T13:37"),
     greg::ymd_hms!(2023-08-17 13:37:00)
 );
 assert_eq!(
     DateTime::parse("2023-12-24 18:00:00"),
     greg::ymd_hms!(2023-12-24 18:00:00)
 );

This is mainly useful in const contexts, since the panic gets caught at compile-time.

 use greg::calendar::DateTime;
 // not a leap year
 const LEAP: DateTime = DateTime::parse("2023-02-29 05:30");

See also the ymd_hms! macro for defining DateTimes with literals at compile-time.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DateTime

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

Same as Display: YYYY-MM-DD hh:mm:ss (i.e. 2022-12-31 12:34:56)

impl<'de> Deserialize<'de> for DateTime

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DateTime

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

Components separated by a space: YYYY-MM-DD hh:mm:ss (i.e. 2022-12-31 12:34:56)

impl FromStr for DateTime

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

Parse Date and Time separated by space or T

May also accept dates with too much or too little 0-padding for the year. Month, day, hour, minute and second segments must be exactly 2 digits. Uses Date::try_parse and Time::try_parse internally, see the documentation there for details.

 use greg::calendar::DateTime;
 use greg::ymd_hms;

 assert_eq!(
     "2022-01-01 00:00:00".parse(),
     Ok(ymd_hms!(2022-01-01 00:00:00))
 );
 assert_eq!(
     "2020-06-06 10:15".parse(),
     Ok(ymd_hms!(2020-06-06 10:15:00))
 );
 assert_eq!(
     "1234-01-23T12:34:56".parse(),
     Ok(ymd_hms!(1234-01-23 12:34:56))
 );

 assert!("2021-01-01".parse::<DateTime>().is_err());
 assert!("09:30:00".parse::<DateTime>().is_err());
 // no leap seconds
 assert!("2016-12-31 23:59:60".parse::<DateTime>().is_err());
 assert!("Jan 1st, 2020 2pm".parse::<DateTime>().is_err());

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for DateTime

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 DateTime

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

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

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

const 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 DateTime

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

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralPartialEq for DateTime