Struct femtos::Instant

pub struct Instant(/* private fields */);

Represents time from the start of the simulation

Instant is for representing the current running clock. It uses a duration to represent the time from simulation start, and is monotonic.

Implementations

impl Instant

pub const START: Self = _

An Instant representing the start of time (t = 0)

pub const FOREVER: Self = _

An Instant representing the greatest possible time (t = Femtos::MAX)

pub const fn as_duration(self) -> Duration

Returns a Duration equivalent to the amount of time elapsed since the earliest possible time (t = 0).

pub fn duration_since(self, other: Self) -> Duration

Returns the Duration that has elapsed between this Instant and other.

Examples

use femtos::{Instant, Duration};

let now = Instant::START + Duration::from_secs(1);
assert_eq!(now.duration_since(Instant::START), Duration::from_secs(1));

pub const fn checked_add(self, duration: Duration) -> Option<Self>

Checked Instant addition. Computes self + duration, returning None if an overflow occured.

Examples

use femtos::{Instant, Duration, Femtos};

assert_eq!(
    Instant::START.checked_add(Duration::from_secs(1)).map(|i| i.as_duration()),
    Some(Duration::from_secs(1))
);
assert_eq!(Instant::FOREVER.checked_add(Duration::from_femtos(1)), None);

pub const fn checked_sub(self, duration: Duration) -> Option<Self>

Checked Instant subtraction. Computes self - duration, returning None if an overflow occured.

Examples

use femtos::{Instant, Duration, Femtos};

assert_eq!(
    Instant::FOREVER.checked_sub(Duration::from_femtos(1)).map(|i| i.as_duration()),
    Some(Duration::from_femtos(Femtos::MAX - 1))
);
assert_eq!(Instant::START.checked_sub(Duration::from_secs(1)), None);

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

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 Debug for Instant

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

Formats the value using the given formatter.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method 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

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

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

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

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

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

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 Copy for Instant

impl Eq for Instant

impl StructuralPartialEq for Instant