Struct Timestamp 

pub struct Timestamp {
    pub t: u128,
}

Default concrete time type used by this crate.

Timestamp stores a time value in u128 nanoseconds.

For custom clocks, implement crate::time::TimePoint on your own type and use it with Registry<T>.

Fields

t: u128

Implementations

impl Timestamp

pub fn now() -> Timestamp

Returns a Timestamp initialized to the current time. This functionality is useful for dynamic transforms.

Examples

use transforms::time::Timestamp;

let now = Timestamp::now();
assert!(now.t > 0);

Panics

Panics if the system time is earlier than UNIX_EPOCH (January 1, 1970).

pub fn zero() -> Timestamp

Returns a Timestamp initialized at zero. This functionality is especially useful for static transforms.

Examples

use transforms::time::Timestamp;

let zero = Timestamp::zero();
assert_eq!(zero.t, 0);

pub fn as_seconds(&self) -> Result<f64, TimeError>

Converts the Timestamp to seconds as a floating-point number.

Returns an error if the conversion results in accuracy loss.

Examples

use transforms::time::Timestamp;

let timestamp = Timestamp { t: 1_000_000_000 };
let result = timestamp.as_seconds();
assert!(result.is_ok());
assert_eq!(result.unwrap(), 1.0);

let timestamp = Timestamp {
    t: 1_000_000_000_000_000_001,
};
let result = timestamp.as_seconds();
assert!(result.is_err());

Errors

Returns TimeError::AccuracyLoss if the conversion is not exact.

pub fn as_seconds_unchecked(&self) -> f64

Converts the Timestamp to seconds as a floating-point number without checking for accuracy.

Examples

use transforms::time::Timestamp;

let timestamp = Timestamp {
    t: 1_000_000_000_000_000_001,
};
let seconds = timestamp.as_seconds_unchecked();
assert_eq!(seconds, 1_000_000_000.0);

Trait Implementations

impl Add<Duration> for Timestamp

type Output = Result<Timestamp, TimeError>

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> <Timestamp as Add<Duration>>::Output

Performs the + operation.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timestamp

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Eq for Timestamp

impl Ord for Timestamp

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Timestamp

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Timestamp

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Timestamp

impl Sub for Timestamp

type Output = Result<Duration, TimeError>

The resulting type after applying the - operator.

fn sub(self, other: Timestamp) -> <Timestamp as Sub>::Output

Performs the - operation.

impl Sub<Duration> for Timestamp

type Output = Result<Timestamp, TimeError>

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> <Timestamp as Sub<Duration>>::Output

Performs the - operation.

impl TimePoint for Timestamp

fn static_timestamp() -> Timestamp

Returns the static timestamp value.

fn duration_since(self, earlier: Timestamp) -> Result<Duration, TimeError>

Returns elapsed time between two timestamps.

fn checked_add(self, rhs: Duration) -> Result<Timestamp, TimeError>

Adds duration to timestamp using checked arithmetic.

fn checked_sub(self, rhs: Duration) -> Result<Timestamp, TimeError>

Subtracts duration from timestamp using checked arithmetic.

fn as_seconds(self) -> Result<f64, TimeError>

Returns timestamp represented in seconds.

fn is_static(self) -> bool

Returns true if this timestamp is the static value.