Skip to main content

Timer

Struct Timer 

Source
pub struct Timer { /* private fields */ }
Expand description

A simple stopwatch timer that supports pause and resume.

Direct port from C++ Timer.h. The timer starts immediately on construction (unless start_paused is true). Use pause() and resume() any number of times; elapsed() returns the total time spent unpaused.

§Examples

use clipper2_rust::utils::timer::Timer;
let timer = Timer::new(false);
// ... do work ...
let elapsed = timer.elapsed();
println!("Took {}", Timer::format_duration(elapsed));

Implementations§

Source§

impl Timer

Source

pub fn new(start_paused: bool) -> Self

Create a new timer. If start_paused is false, the timer starts immediately.

Source

pub fn restart(&mut self)

Restart the timer from zero.

Source

pub fn resume(&mut self)

Resume a paused timer. No-op if already running.

Source

pub fn pause(&mut self)

Pause a running timer. No-op if already paused.

Source

pub fn elapsed(&self) -> Duration

Return the total elapsed duration (excluding paused intervals).

If the timer is currently running, includes time since last resume. If the timer is paused, returns accumulated time only.

Source

pub fn elapsed_nanos(&self) -> u128

Return elapsed time in nanoseconds. Direct port from C++ elapsed_nano().

Source

pub fn format_duration(dur: Duration) -> String

Format a duration as a human-readable string. Direct port from C++ elapsed_str().

Automatically selects appropriate units (microsecs, millisecs, secs).

Source

pub fn elapsed_str(&self) -> String

Return elapsed time as a human-readable string.

Trait Implementations§

Source§

impl Default for Timer

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Timer

§

impl RefUnwindSafe for Timer

§

impl Send for Timer

§

impl Sync for Timer

§

impl Unpin for Timer

§

impl UnwindSafe for Timer

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> 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.