Struct Time 

pub struct Time {
    pub value: String,
    pub format: TimeFormat,
    pub scale: TimeScale,
    pub location: Location,
    pub civil: Option<Civil>,
}

A time as it appears in a file.

Fields

value: String

The value exactly as written.

format: TimeFormat

The effective format, with format and base_format collapsed.

scale: TimeScale

The time scale.

location: Location

The observer’s location, for location-sensitive scales.

civil: Option<Civil>

The derived calendar breakdown, once computed.

Implementations

impl Time

pub fn new( value: impl Into<String>, format: TimeFormat, scale: TimeScale, ) -> Self

A time with the given value and format.

pub fn parse(doc: &Document, id: NodeId) -> Result<Self>

Read a time/time value from the tree.

The schema allows two shapes: the whole tagged value as a string, or a mapping with the string under value and optional format, base_format, scale and location.

The wire format says how to read the value; base_format records the object’s real format and overrides only what it reports afterwards. An astropy plot_date is stored as an ISO string with base_format: plot_date, so collapsing the two before parsing would try to read a date as a matplotlib ordinal.

The calendar breakdown is computed where the value allows it; a value that will not parse is not an error, since the value, format and scale round-trip regardless and the breakdown is a convenience.

pub fn compute_civil(&mut self) -> Result<Civil>

Compute the calendar breakdown from the value, format and scale.

Approximate for anything off the UTC scale; see the module comment.

pub fn wire_formats(&self) -> (TimeFormat, Option<TimeFormat>)

The pair of values to write: the wire format, and base_format when the effective format may not appear in format.

Trait Implementations

impl Clone for Time

fn clone(&self) -> Time

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl PartialEq for Time

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Time