DeltaTimer

Struct DeltaTimer 

Source
pub struct DeltaTimer<const S: bool>
where BaseTimer<S>: Default, TDesc<S>: TArch,
{ /* private fields */ }
Expand description

A timer that uses the underlying CPU clock ticks to generate precise timings for short-term execution

This should not be expected to be correct in all cases; if a thread sleeps or is interrupted, for example by the kernel, for any reason, then the CPU timer value may not be useful; if the thread migrates to a different CPU core it may become invalid; etc

The usage model is to capture a ‘start’ time and a ‘stop’ time; the value method can then be used to retrieve the CPU ticks between the start and stop

let mut t = DeltaTimer::<true>::default();
t.start();
// do something!
t.stop();
println!("That took {} ticks", t.value());

Implementations§

Source§

impl<const S: bool> DeltaTimer<S>
where TDesc<S>: TArch,

Source

pub fn clear(&mut self)

Clear the timer and accumulated values

Source

pub fn start(&mut self)

Record the ticks at the start of the timer

Source

pub fn delta(&mut self) -> u64

Return (without updating) the delta since start

Source

pub fn stop(&mut self)

Record the delta time since the last start

Source

pub fn value(&self) -> u64

Return the delta time in ticks

Trait Implementations§

Source§

impl<const S: bool> Clone for DeltaTimer<S>
where BaseTimer<S>: Default, TDesc<S>: TArch,

Source§

fn clone(&self) -> DeltaTimer<S>

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<const S: bool> Debug for DeltaTimer<S>
where BaseTimer<S>: Default, TDesc<S>: TArch,

Source§

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

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

impl<const S: bool> Default for DeltaTimer<S>
where BaseTimer<S>: Default, TDesc<S>: TArch,

Source§

fn default() -> DeltaTimer<S>

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

impl<const S: bool> Copy for DeltaTimer<S>
where BaseTimer<S>: Default, TDesc<S>: TArch,

Auto Trait Implementations§

§

impl<const S: bool> !Freeze for DeltaTimer<S>

§

impl<const S: bool> !RefUnwindSafe for DeltaTimer<S>

§

impl<const S: bool> !Send for DeltaTimer<S>

§

impl<const S: bool> !Sync for DeltaTimer<S>

§

impl<const S: bool> !Unpin for DeltaTimer<S>

§

impl<const S: bool> !UnwindSafe for DeltaTimer<S>

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.