Struct time_elapsed::TimeElapsed

pub struct TimeElapsed { /* private fields */ }

Stores the benchmark state and provides methods (timestamp method needs a mutable reference).

To create an initialized instance use the time_elapsed::start function.

example

let mut time = time_elapsed::start("test");
// output: running test...
 

Implementations

impl TimeElapsed

pub fn end(self)

Ends the benchmark. Outputs the total elapsed time from the start of the benchmark.

example

let mut time = time_elapsed::start("test");
// output: running test...
 
time.end();
// output: test finished in 1 μs (1204 ns)
 

pub fn log<S: AsRef<str>>(&mut self, msg: S) -> &mut Self

Outputs a message followed by the elapsed time from the previous timestamp.

Returns a mutable reference of self.

example

let mut time = time_elapsed::start("test");
// output: running test...
 
time.log("My message");
// output: (test) My message -> 1 μs
 

pub fn log_overall<S: AsRef<str>>(&mut self, msg: S) -> &mut Self

Outputs a message followed by the elapsed time from the start, ignoring timestamps.

Returns a mutable reference of self.

example

use std::thread;
use std::time::Duration;
 
let mut time = time_elapsed::start("test");
// output: running test...
 
thread::sleep(Duration::from_millis(200));
 
time.timestamp();
time.log_overall("The elapsed time from the start");
// output: (test) The elapsed time from the start -> 200 ms
 

pub fn timestamp(&mut self) -> Instant

Updates and returns the last timestamp.

example

use std::thread;
use std::time::Duration;
let mut time = time_elapsed::start("test");
// output: running test...
 
thread::sleep(Duration::from_millis(200));
 
time.timestamp();
 
time.log("Elapsed time from the prev timestamp");
// output: (test) Elapsed time from the prev timestamp -> 1 μs
 

Trait Implementations

impl Clone for TimeElapsed

fn clone(&self) -> TimeElapsed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeElapsed

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

Formats the value using the given formatter.

impl Hash for TimeElapsed

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 Ord for TimeElapsed

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TimeElapsed> for TimeElapsed

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TimeElapsed> for TimeElapsed

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TimeElapsed

impl StructuralEq for TimeElapsed

impl StructuralPartialEq for TimeElapsed