superluminal-perf 0.3.0

Superluminal Performance API for adding user events to profiler captures
Documentation

🔆 superluminal-perf-rs

Embark Embark Crates.io Docs dependency status Build Status

Superluminal Performance profiler Rust API for adding user events to captures.

How to use

In Cargo.toml add:

[dependencies]
superluminal-perf = "0.2.0"

Example usage:

superluminal_perf::begin_event("my-event");
calc();
superluminal_perf::end_event();

superluminal_perf::begin_event("my-event2");
calc2();
superluminal_perf::end_event();

On non-Windows platforms the events will be compiled out.

Contributing

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

Licensed under either of

at your option.

Note that the Superluminal Performance C API, that this crate uses and embeds, is licensed under BSD.

Contribution

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