Struct Tick 

pub struct Tick<W>
where
    W: TickWidth,
{ /* private fields */ }

A tick count of width W: monotonic since scheduler start, wrapping at W::MAX exactly as the C kernel’s xTickCount does.

Stored as a u64 masked to the width, so the same code path serves every width and every arithmetic test can be run at all three on the host.

Implementations

impl<W> Tick<W>

where W: TickWidth,

pub const ZERO: Tick<W>

Tick zero.

pub const MAX: Tick<W>

The largest count; also portMAX_DELAY, the “forever” timeout.

pub const fn new(raw: u64) -> Tick<W>

A count, masked to the width (a value above W::MAX wraps).

pub const fn get(self) -> u64

The count as a number.

pub const fn bits() -> u32

The width in bits.

pub const fn wrapping_add(self, n: u64) -> Tick<W>

self + n, wrapping at the width (the tick interrupt’s increment).

pub const fn wrapping_sub(self, n: u64) -> Tick<W>

self - n, wrapping at the width.

pub const fn checked_add(self, n: u64) -> Option<Tick<W>>

self + n, or None if the result would wrap. Blocking APIs use this to know whether a wake time lands in the overflow delayed list.

pub const fn since(self, earlier: Tick<W>) -> u64

Ticks elapsed from earlier to self, wrapping (the C kernel’s xTickCount - xTimeOnEntering idiom).

pub const fn overflows_by(self, n: u64) -> bool

Whether adding n to self crosses the wrap point (the wake time belongs in the overflow delayed list).

Trait Implementations

impl<W> Clone for Tick<W>

where W: Clone + TickWidth,

fn clone(&self) -> Tick<W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W> Copy for Tick<W>

where W: Copy + TickWidth,

impl<W> Debug for Tick<W>

where W: TickWidth,

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

Formats the value using the given formatter.

impl<W> Default for Tick<W>

where W: TickWidth,

fn default() -> Tick<W>

Returns the “default value” for a type.

impl<W> Display for Tick<W>

where W: TickWidth,

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

Formats the value using the given formatter.

impl<W> Eq for Tick<W>

where W: Eq + TickWidth,

impl<W> Hash for Tick<W>

where W: Hash + TickWidth,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<W> Ord for Tick<W>

where W: Ord + TickWidth,

fn cmp(&self, other: &Tick<W>) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<W> PartialEq for Tick<W>

where W: PartialEq + TickWidth,

fn eq(&self, other: &Tick<W>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<W> PartialOrd for Tick<W>

where W: PartialOrd + TickWidth,

fn partial_cmp(&self, other: &Tick<W>) -> 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<W> StructuralPartialEq for Tick<W>

where W: PartialEq + TickWidth,