Tick

Struct Tick 

Source
pub struct Tick(/* private fields */);
Expand description

Represents a point in time as measured by the system tick counter.

This struct is used to keep track of time in terms of ticks, which can be compared or used to measure elapsed time.

Implementations§

Source§

impl Tick

Source

pub fn now() -> Self

Returns the current system tick value.

§Examples
let current_tick = Tick::now();
Source

pub fn elapsed(self) -> TickType

Computes the number of ticks elapsed since the creation of this Tick instance.

§Examples
let start_tick = Tick::now();
let elapsed_ticks = start_tick.elapsed();
Source

pub const fn with_value(value: TickType) -> Self

Creates a new Tick instance with the given value.

§Arguments
  • value - The value to initialize the Tick with.
§Returns
  • A new Tick instance.
Source

pub fn tick() -> TickType

Retrieves the current tick value.

§Returns
  • The current tick value.
Source

pub fn elapsed_time(self) -> Duration<TickType, 1, TICK_FREQ_HZ>

Calculates the elapsed time since the creation of the Tick instance.

§Returns
  • A Duration representing the elapsed time in ticks.

Trait Implementations§

Source§

impl Add for Tick

Source§

type Output = Tick

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl Clone for Tick

Source§

fn clone(&self) -> Tick

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tick

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Tick

Source§

fn default() -> Tick

Returns the “default value” for a type. Read more
Source§

impl HalTickHandler for Tick

Source§

unsafe fn on_sys_tick_interrupt()

This function is called by a hardware interrupt to update the system’s tick count. Depending on the build features, it supports either 32-bit or 64-bit tick counters.

Source§

impl Ord for Tick

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Tick

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Tick

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Sub for Tick

Source§

type Output = Tick

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation. Read more
Source§

impl Copy for Tick

Source§

impl Eq for Tick

Source§

impl StructuralPartialEq for Tick

Auto Trait Implementations§

§

impl Freeze for Tick

§

impl RefUnwindSafe for Tick

§

impl Send for Tick

§

impl Sync for Tick

§

impl Unpin for Tick

§

impl UnwindSafe for Tick

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.