Struct DateTime 

#[non_exhaustive]
pub struct DateTime<'a> {
    pub date: Date,
    pub time: Time,
    pub offset: Option<i32>,
    pub zone: Option<&'a str>,
    pub options: DateTimeOptions<'a>,
}

A date/time value: an application’s argument (crate::Arg::DateTime, crate::CustomValue::as_date_time), a literal a date/time function parsed, or what :datetime, :date or :time resolved — the value with its DateTimeOptions. Build it with the constructors.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

date: Date

The civil date (in the value’s offset, or floating).

time: Time

The wall-clock time (00:00 when the value has no time).

offset: Option<i32>

Seconds east of UTC; None: floating — no offset, so the formatting time zone applies without conversion (datetime.md, “Date and Time Operands”).

zone: Option<&'a str>

The IANA time zone the value is in, when it names one.

options: DateTimeOptions<'a>

What a date/time function resolved; empty for an argument, except for the override options an application value may carry.

Implementations

impl<'a> DateTime<'a>

pub const fn floating(date: Date, time: Time) -> DateTime<'a>

A floating date and time.

pub const fn from_epoch_ms(ms: i64) -> Option<DateTime<'a>>

The instant ms milliseconds after 1970-01-01T00:00:00Z, in UTC (datetime.md: an offset from an epoch includes UTC as its zone).

pub const fn to_epoch_ms(&self) -> Option<i64>

The instant, in milliseconds since the epoch; None when floating.

pub const fn with_offset(self, seconds: i32) -> Option<Self>

The same wall time at UTC offset seconds; None unless |seconds| < 86,400.

pub const fn in_zone(self, zone: &'a str) -> Self

The same value, in the IANA zone zone. A value with an offset is an instant, and stays one: a date/time function shows it at the zone’s wall time, converting through Host::zone_offset when the offset is not the zone’s. A floating value’s wall time is placed in zone.

pub fn write_iso(&self, out: &mut dyn Sink)

Writes the ISO 8601 / RFC 9557 text: 2006-01-02T15:04:06, with .mmm when there are milliseconds, Z or ±hh:mm when the value has an offset, [zone] when it names one — how an unannotated date/time formats (plans/03-runtime.md §2.7).

Trait Implementations

impl<'a> Clone for DateTime<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DateTime<'a>

impl<'a> Debug for DateTime<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for DateTime<'a>

impl<'a> From<&'a DateTime<'a>> for Arg<'a>

fn from(d: &'a DateTime<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for DateTime<'a>

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<'a> PartialEq for DateTime<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DateTime<'a>