Struct Guard

pub struct Guard<'sw, I: Instant> { /* private fields */ }

A running, guarded, stopwatch. When dropped, the stopwatch will automatically stop.

Guards are returned by the StopwatchImpl methods guard and guard_at.

Examples

let mut sw = Sw::new();
{
    let _guard = sw.guard()?;
    // stopwatch is now running and guarded!
    thread::sleep(Duration::from_millis(100));
    // guard dropped, stopwatch stopped
}
assert!(sw.is_stopped());
assert!(sw.elapsed() >= Duration::from_millis(100));

Implementations

impl<'sw, I: Instant> Guard<'sw, I>

pub fn new(sw: &'sw mut StopwatchImpl<I>) -> Result<Self>

Returns a Guard to a running stopwatch.

Errors

If the stopwatch is stopped, returns GuardNew.

Examples

use std::time::Instant;
let mut sw = Sw::new();
assert_eq!(Guard::new(&mut sw), Err(Error::GuardNew));

sw.start()?;
assert!(Guard::new(&mut sw).is_ok());
assert!(sw.is_stopped());

pub const fn inner(&self) -> &StopwatchImpl<I>

Returns a reference to the inner StopwatchImpl.

Examples

let mut sw = Sw::new();
let guard = sw.guard()?;
thread::sleep(Duration::from_millis(100));
assert!(guard.inner().elapsed() >= Duration::from_millis(100));

Trait Implementations

impl<'sw, I: Debug + Instant> Debug for Guard<'sw, I>

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

Formats the value using the given formatter.

impl<I: Instant> Drop for Guard<'_, I>

fn drop(&mut self)

Releases the guard, calling stop on the guarded stopwatch.

impl<'sw, I: Hash + Instant> Hash for Guard<'sw, I>

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

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<I: Instant> PartialEq for Guard<'_, I>

fn eq(&self, rhs: &Self) -> 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<I: Instant> Eq for Guard<'_, I>