Struct Instant 

pub struct Instant {
    micros: NonZero<u64>,
}

Available on crate feature osal-freertos only.

An Instant in time. Instants should be always increasing and are generally obtainable through the operating system time driver.

Fields

micros: NonZero<u64>

Implementations

impl Instant

pub const MAX: Instant

The largest value that can be represented by the Instant type.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

assert!(Instant::MAX > now);

pub const MIN: Instant

The smallest value that can be represented by the Instant type.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

assert!(Instant::MIN <= now);

pub const fn duration_since(&self, earlier: Instant) -> Option<Duration>

Returns the Duration between this Instant and the give one if, and only if, the given one is earlier than this, otherwise returns None.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let begin = Time::now();

std::thread::sleep(core::time::Duration::from_millis(1));

let end = Time::now();
assert!(end.duration_since(begin).unwrap() > Duration::ZERO);
assert_eq!(begin.duration_since(end), None);

pub fn checked_add(self, rhs: Duration) -> Option<Instant>

Adds one Duration to self, returning a new Instant or None in the event of an overflow.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

assert!(now.checked_add(Duration::from_secs(1)).unwrap() > now);
assert_eq!(now.checked_add(Duration::MAX), None);

pub fn checked_sub(&self, rhs: Duration) -> Option<Instant>

Subs one Duration from self, returning a new Instant or None in the event of an underflow.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let begin = Time::now();

std::thread::sleep(core::time::Duration::from_millis(1));

let end = Time::now();

assert!(end.checked_sub(Duration::from_millis(1)).unwrap() < end);
assert_eq!(end.checked_sub(Duration::MAX), None);

Trait Implementations

impl Add<Duration> for Instant

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

Panics

This function may panic if the resulting instant overflows. See Instant::checked_add for a version without panic.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

assert!(now + Duration::from_secs(1) > now);

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

let _ = now + Duration::MAX;

type Output = Instant

The resulting type after applying the + operator.

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

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

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};

let instant = Instant::MIN + Duration::from_millis(1980);
assert_eq!(format!("{instant:?}"), "1s.980000us");

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 Sub<Duration> for Instant

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

Panics

This function may panic if the resulting instant underflows. See Instant::checked_sub for a version without panic.

Examples

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let begin = Time::now();

std::thread::sleep(core::time::Duration::from_millis(1));

let end = Time::now();

assert!(end - Duration::from_millis(1) < end);

use veecle_osal_api::time::{Duration, Instant, TimeAbstraction};
use veecle_osal_std::time::Time;

let now = Time::now();

let _ = now - Duration::MAX;

type Output = Instant

The resulting type after applying the - operator.

impl Copy for Instant

impl Eq for Instant

impl StructuralPartialEq for Instant