3 releases

0.1.2 Oct 13, 2019
0.1.1 Sep 30, 2019
0.1.0 Sep 30, 2019

#298 in Command-line interface

Download history 1454/week @ 2023-11-25 1537/week @ 2023-12-02 1629/week @ 2023-12-09 1436/week @ 2023-12-16 908/week @ 2023-12-23 945/week @ 2023-12-30 1628/week @ 2024-01-06 1910/week @ 2024-01-13 1546/week @ 2024-01-20 2041/week @ 2024-01-27 2097/week @ 2024-02-03 2279/week @ 2024-02-10 2437/week @ 2024-02-17 2258/week @ 2024-02-24 1801/week @ 2024-03-02 1376/week @ 2024-03-09

8,385 downloads per month
Used in 2 crates

MIT license

8KB
82 lines

Build status on GitLab CI Newest release on crates.io Documentation Number of downloads on crates.io Project license

took: easily measure & report elapsed time

I always find measuring and reporting run time of code it in a human readable format troublesome.

This crate provides a few simple interfaces to do just that.

Examples

  • Measure & report manually using Timer stopwatch:

    use took::Timer;
    
    let timer = Timer::new();
    // Run heavy task
    println!("Done! Took {}", timer.took());
    
    // Prints:
    // Done! Took 1.00 s
    
  • Measure a function, report manually:

    use took::took;
    
    let (took, result) = took(|| {
        // Run heavy task
    });
    println!("Done, took {}", took);
    
    // Prints:
    // Done! Took 1.00 s
    
  • Measure & report a function automatically using attribute:

    #[macro_use]
    extern crate took_macro;
    
    my_function();
    other_function();
    
    #[took]
    pub fn my_function() {
        // Run heavy task
    }
    
    #[took(description = "Render finished,")]
    pub fn other_function() {
        // Run heavy task
    }
    
    // Prints:
    // my_function() took 1.00 s
    // Render finished, took 1.00 s
    

Requirements

  • Rust 1.33 or newer (with std)

Usage

Add the dependencies in your Cargo.toml. The took-macro dependency is only required if you'll be using the #[took] attribute macro.

[dependencies]
took = "0.1"
took-macro = "0.1" # if using macros

Import and start using:

use took::{Timer, took};

let timer = Timer::new();
println!("Done! Took {}", timer.took());

let (took, result) = took(|| {
    // Run heavy task
});
println!("Done, took {}", took);

If you'll be using #[took] attribute macro, explicitly import it:

#[macro_use]
extern crate took_macro;

#[took]
pub fn function_one() {}

#[took(description = "Some heavy logic finished,")]
pub fn function_two() {}

TODO

  • Support #[took] attribute for almost anything (function call, blocks, if-statements, ...)
  • Time formatting configurability
  • Use more precise timers
  • Print elapsed time to more than just stderr

License

This project is released under the MIT license. Check out the LICENSE file for more information.

No runtime deps