Struct Instant 

pub struct Instant { /* private fields */ }

Exact, non-negative point in time held as a reduced rational number of seconds.

Clock conversions need a time base that is free of floating-point rounding, so an Instant stores a numerator and denominator (both in seconds) and keeps them in lowest terms with a positive denominator. Stream instants are always non-negative; constructing a negative value fails closed.

Examples

use sim_lib_stream_clock::Instant;

let half = Instant::new(1, 2)?;
let one = Instant::seconds(1);
let sum = one.checked_add(half)?;
assert_eq!(sum.numerator(), 3);
assert_eq!(sum.denominator(), 2);

Implementations

impl Instant

pub fn new(numerator: i128, denominator: i128) -> Result<Self>

Builds an instant of numerator / denominator seconds, reduced to lowest terms with a positive denominator.

Returns an error when denominator is zero, when the reduced value would be negative, or when normalizing the sign overflows i128.

pub fn seconds(seconds: u64) -> Self

Returns the instant for a whole number of seconds.

pub fn numerator(self) -> i128

Returns the numerator of the reduced seconds fraction.

pub fn denominator(self) -> i128

Returns the (always positive) denominator of the reduced seconds fraction.

pub fn checked_add(self, other: Self) -> Result<Self>

Returns the sum of self and other, reduced to lowest terms.

Returns an error when the cross-multiplied addition overflows i128.

pub fn checked_sub(self, other: Self) -> Result<Self>

Returns the difference self - other, reduced to lowest terms.

Returns an error when the subtraction overflows i128 or when the result would be negative (stream instants are non-negative).

Trait Implementations

impl Clone for Instant

fn clone(&self) -> Instant

Returns a duplicate 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 Eq for Instant

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

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 Instant

fn eq(&self, other: &Instant) -> 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 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: &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 Instant