Struct ephemeris::Instant

pub struct Instant { /* fields omitted */ }

An instantaneous point in time along the timeline.

This is explicitly a TAI instant. This means that, among other things, the civil time an instant maps to (a normal calendar date and time) changes over time, as leap seconds are added to the civil clock.

Methods

impl Instant

pub const MIN: Instant

Constant for the earliest possible instant.

pub const EPOCH: Instant

Constant for the epoch instant, that is, '1970-01-01 00:00:00.000000000Z'.

pub const MAX: Instant

Constant for the last possible instant.

pub fn of_epoch_milli(epoch_milliseconds: i64) -> Instant

Obtains an Instant using milliseconds since '1970-01-01 00:00:00.000Z'.

The seconds and fractional seconds are calculated from the provided milliseconds.

Parameters

• epoch_milliseconds: the milliseconds since the epoch.

pub fn of_epoch_second(epoch_seconds: i64) -> Instant

Obtains an Instant using seconds since '1970-01-01 00:00:00Z'.

Parameters

• epoch_seconds: the seconds in the duration.

pub fn of_epoch_second_and_adjustment(
    epoch_seconds: i64,
    nano_adjustment: i64
) -> Instant

Obtains an Instant using seconds and an adjustment in nanoseconds since '1970-01-01 00:00:00.000000000Z'.

Parameters

• epoch_seconds: the seconds since the epoch.
• nano_adjustment: the adjustment amount from the given second.

Panics

• if the adjusted amount of seconds would be before the minimum instant, or after the maximum instant.

pub fn epoch_second(&self) -> i64

Gets the number of seconds before or after the epoch.

pub fn nano(&self) -> u32

Gets the number of nanoseconds farther along the timeline in this instant.

Trait Implementations

impl Clone for Instant

fn clone(&self) -> Instant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Instant

impl Debug for Instant

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

Formats the value using the given formatter.

impl Default for Instant

fn default() -> Instant

Returns the "default value" for a type.

impl Eq for Instant

impl Hash for Instant

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Instant

fn cmp(&self, other: &Instant) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Instant> for Instant

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Instant> for Instant

fn partial_cmp(&self, other: &Instant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Instant) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Instant) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Instant) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Instant) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Instant

impl StructuralPartialEq for Instant