Struct DateTime 

pub struct DateTime {
    pub year: i32,
    pub month: u8,
    pub day: u8,
    pub hour: u8,
    pub minute: u8,
    pub second: u8,
}

A broken-down civil date and time, in UTC unless a caller has deliberately shifted it.

Fields

year: i32

Proleptic Gregorian year.

month: u8

Month, 1–12.

day: u8

Day of month, 1–31.

hour: u8

Hour, 0–23.

minute: u8

Minute, 0–59.

second: u8

Second, 0–59. Leap seconds are not represented: receivers report UTC with the leap second smeared or repeated, and a second that cannot be encoded is worse than one that is merely repeated.

Implementations

impl DateTime

pub const EPOCH: Self

The Unix epoch itself, 1970-01-01T00:00:00Z.

pub const fn is_valid(&self) -> bool

Whether every field is in range and the day exists in its month.

Note what this does not check: a year outside the range to_unix can encode is still a valid date, and is rejected there instead.

pub const fn to_unix(&self) -> Option<u32>

Seconds since the Unix epoch, or None when the date is invalid or falls outside what PROP_TIME can carry.

A receiver reporting a date before 1970 or past 2106 is reporting a receiver fault, not a time, so refusing is the right answer: silently clamping would set a clock to a value the device would then defend.

pub const fn from_unix(seconds: u32) -> Self

Break a Unix second count down into civil fields.

Total: every u32 names a real UTC instant, so unlike to_unix there is nothing to refuse.

pub const fn shifted(&self, offset_minutes: i16) -> Option<Self>

This instant shifted by a time-zone offset in minutes east of UTC, for rendering a local time.

The result is a wall-clock reading, not an instant: it no longer converts back through to_unix to what it came from, which is exactly what makes it presentation. None when the shift leaves the representable range.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DateTime

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

Formats the value using the given formatter.

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 ==.

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

impl Eq for DateTime

impl StructuralPartialEq for DateTime