Struct DateTime 

pub struct DateTime { /* private fields */ }

A civil time of a day on a particular Gregorian date.

Implementations

impl DateTime

pub const MIN: DateTime

The minimum allowed Gregorian date and clock time.

pub const MAX: DateTime

The maximum allowed Gregorian date and clock time.

pub const fn new( year: i16, month: i8, day: i8, hour: i8, minute: i8, second: i8, subsec_nanosecond: i32, ) -> Result<DateTime, RangeError>

Creates a new civil datetime from its constituent components.

If any of the values are out of their supported ranges, then an error is returned. Additionally, if year, month and day do not correspond to a valid Gregorian date, then an error is returned.

pub const fn from_parts(date: Date, time: Time) -> DateTime

Creates a new DateTime from its Date and Time components.

pub const fn date(&self) -> Date

Returns the Gregorian date component of this datetime.

pub const fn time(&self) -> Time

Returns the civil time component of this datetime.

pub const fn checked_add_seconds( &self, seconds: i32, ) -> Result<DateTime, RangeError>

Adds the given number of seconds to this civil datetime.

This returns an error when the resulting datetime would exceed either DateTime::MIN or DateTime::MAX.

pub const fn saturating_add_seconds(&self, seconds: i32) -> DateTime

Like DateTime::checked_add_seconds, but arithmetic saturates to either DateTime::MIN (when seconds < 0) or DateTime::MAX (when seconds > 0).

pub const fn to_timestamp( &self, offset: Offset, ) -> Result<Timestamp, RangeError>

Converts this datetime, along with its offset from UTC, to a corresponding Unix timestamp.

Note that unlike the reverse operation, Timestamp::to_datetime, this is fallible. This is by design. Namely, by making this routine fallible at the boundaries, it permits the reverse operation to be infallible. That is, all instants can be converted to a civil datetime (appropriate for formatting), but not all civil datetimes combined with all UTC offsets can be converted to an instant in time.

This errors when the timestamp returned would be outside the range given by Timestamp::MIN and Timestamp::MAX.

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

impl Debug for DateTime

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

Formats the value using the given formatter.

impl Eq for DateTime

impl Format for DateTime

where Date: Format, Time: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<DateTime> for DateTime

Creates a new bit packed datetime from jiff-core’s standard datetime type.

Note that this completely ignores any fractional second component on the provided datetime.

fn from(dt: DateTime) -> DateTime

Converts to this type from the input type.

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

Equality operator ==.

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

Inequality operator !=.

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