Struct Plan 

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

What a backend formats: backend-independent, everything MF2 decided.

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 date to show: the wall date in Plan::zone.

time: Time

The time to show: the wall time in Plan::zone, to the millisecond.

offset: Option<i32>

The zone’s UTC offset at that instant, in seconds east; None: not known — a floating value placed in a named zone the host has no data for.

zone: ZoneOption<'p>

The zone the value is shown in: ZoneOption::Utc, an offset or a named zone, never ZoneOption::Input. What timeZoneStyle names.

options: &'p DateTimeOptions<'p>

The resolved options: date (fields and length) for :datetime and :date, time (precision) for :datetime and :time, time_zone_style, hour12, calendar. Their time_zone is the option (the inheritance record): a backend shows Plan::zone.

Implementations

impl<'p> Plan<'p>

pub fn new(cx: &FnContext<'p>, value: &'p DateTime<'p>) -> Plan<'p>

The plan of value, which a date/time function resolved in the context cx (so it is in the zone its options.time_zone names, the context’s when None).

pub fn wall_ms(&self) -> i64

The wall time, in milliseconds since the epoch, read as UTC.

pub fn epoch_ms(&self) -> Option<i64>

The instant, in milliseconds since the epoch; None when the offset is not known.

pub fn request(&self) -> DateTimeRequest<'p>

The request for a host’s date formatter (Host::format_date_time, datetime-intl): the instant in Plan::zone; without a known offset, the wall time read as UTC, shown in UTC (the same wall time, but the zone is lost).

Trait Implementations

impl<'p> Clone for Plan<'p>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'p> Copy for Plan<'p>

impl<'p> Debug for Plan<'p>

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

Formats the value using the given formatter.

impl<'p> Eq for Plan<'p>

impl<'p> PartialEq for Plan<'p>

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

Equality operator ==.

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

Inequality operator !=.

impl<'p> StructuralPartialEq for Plan<'p>