Struct hourglass::Timespec

pub struct Timespec { /* fields omitted */ }

An offset from the Unix Epoch.

Timespec is the building block of Datetime and can be converted from and to a Datetime. It is intrinsically expressed in the UTC timezone since it holds the number of seconds elapsed since the Unix Epoch 1970-01-01T00:00:00Z and therefore is not ambiguous.

It is equivalent to a Datetime without Timezone information and therefore does not have access to as much methods as its counterpart. For example, its date representation cannot be computed. In return, the type is simpler and easier to handle and move around. Like Datetime, Timespec is leap second aware.

Methods

impl Timespec

pub fn now() -> Timespec

Return the Timespec representing now.

pub fn unix(stamp: i64, nano: i32) -> Result<Timespec, InputError>

Create a new Timespec from a Unix timestamp. An InputError is returned if nano ∉ [0, 999999999].

pub fn seconds(&self) -> i64

Get the number of Unix seconds since the Unix Epoch.

pub fn nanoseconds(&self) -> i32

Get the number of nanoseconds elapsed for the current second.

pub fn to_datetime<'a>(&self, tz: &'a Timezone) -> Datetime<'a>

Convert the Timespec into a Datetime, given a Timezone. Note the Timespec is always expressed as a Unix time, so converting to a Datetime won't interpret the Timespec as anything other than an offset from Unix Epoch in UTC timezone.

Trait Implementations

impl Clone for Timespec

fn clone(&self) -> Timespec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Timespec

fn cmp(&self, other: &Timespec) -> 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 Eq for Timespec

impl Copy for Timespec

impl PartialOrd<Timespec> for Timespec

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl PartialEq<Timespec> for Timespec

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

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

#[must_use]

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

This method tests for !=.

impl Debug for Timespec

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

Formats the value using the given formatter.

impl Add<Deltatime> for Timespec

type Output = Timespec

The resulting type after applying the + operator.

fn add(self, rhs: Deltatime) -> Self::Output

Performs the + operation.

impl Sub<Deltatime> for Timespec

type Output = Timespec

The resulting type after applying the - operator.

fn sub(self, rhs: Deltatime) -> Self::Output

Performs the - operation.

impl Sub<Timespec> for Timespec

type Output = Deltatime

The resulting type after applying the - operator.

fn sub(self, rhs: Timespec) -> Self::Output

Performs the - operation.