Crate time_elapsed

A Rust crate that provides a concise and handy way to benchmark elapsed time inside functions.

time-elapsed brings a small overhead, however, if you are trying to measure very small durations (in the order of nanoseconds or few microseconds), please consider using something else.

installation

Add the following to Cargo.toml

[dependencies]
time-elapsed = "0.1.0"

features

• named benchmark
• timestamps
• coloured messages
• auto unit of measurement

example

code

use std::thread;
use std::time::Duration;
 
use time_elapsed;
 
fn main() {
    let mut time = time_elapsed::start("test");
 
    // sleep 200 ms
    thread::sleep(Duration::from_millis(200));
 
    time
        .log("log() prints a message and the time elapsed")
        .timestamp();
 
    // sleep 2 ms
    thread::sleep(Duration::from_millis(2));
 
    time.log("this is an offset from the previous timestamp()");
 
    time.log_overall("log_overall() ignores timestamps");
 
    time.end();
}

output

running test...
(test) log() prints a message and the time elapsed -> 200ms
(test) this is an offset from the previous timestamp() -> 2103 μs
(test) log_overall() ignores timestamps -> 202 ms
test finished in 202 ms (202271 μs)

Structs

TimeElapsed

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

Functions

start

Starts the benchmark by returning an initialized instance of TimeElpased.