An open API service indexing awesome lists of open source software.

https://github.com/xu-cheng/howlong

:watch: Measure how long it takes for a program to execute in different clocks
https://github.com/xu-cheng/howlong

profiling-library rust timer-clock

Last synced: about 1 month ago
JSON representation

:watch: Measure how long it takes for a program to execute in different clocks

Awesome Lists containing this project

README

        

# howlong

[![Build Status](https://github.com/xu-cheng/howlong/workflows/build/badge.svg)](https://github.com/xu-cheng/howlong/actions)
[![Latest Version](https://img.shields.io/crates/v/howlong.svg)](https://crates.io/crates/howlong)
[![Rust Documentation](https://docs.rs/howlong/badge.svg)](https://docs.rs/howlong)

This crate allows you to measure how long it takes for a program to execute in different clocks. It ports the functions of the [`boost-chrono`](https://boost.org/libs/chrono) and [`boost-timer`](https://boost.org/libs/timer) libraries.

The following clocks and their corresponding timers are implemented.

* `SystemClock`, `SystemTimer`
* `SteadyClock`, `SteadyTimer` if supported by the system.
* `HighResolutionClock`, `HighResolutionTimer`
* `ProcessRealCPUClock`, `ProcessRealCPUTimer`
* `ProcessUserCPUClock`, `ProcessUserCPUTimer`
* `ProcessSystemCPUClock`, `ProcessSystemCPUTimer`
* `ProcessCPUClock`, `ProcessCPUTimer`
* `ThreadClock`, `ThreadTimer`

## Documentation

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
howlong = "0.1"
```

## Examples

```rust
let timer = howlong::HighResolutionTimer::new();
// do some computations
println!("{:?} have passed.", timer.elapsed());

let timer = howlong::ProcessCPUTimer::new();
// do other computations
println!("{}", timer.elapsed()); // 5.71s wall, 5.70s user + 0ns system = 5.70s CPU (99.8%)
```

## License


Licensed under either of Apache License, Version 2.0 or MIT license at your option.




Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.