https://github.com/embarkstudios/superluminal-perf-rs

🔆 Superluminal Performance profiler Rust API 🦀
https://github.com/embarkstudios/superluminal-perf-rs

Last synced: about 1 year ago
JSON representation

🔆 Superluminal Performance profiler Rust API 🦀

• Host: GitHub
• URL: https://github.com/embarkstudios/superluminal-perf-rs
• Owner: EmbarkStudios
• License: apache-2.0
• Created: 2020-02-03T19:33:22.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-05-07T08:06:32.000Z (about 1 year ago)
• Last Synced: 2025-06-26T12:56:58.492Z (about 1 year ago)
• Language: Rust
• Homepage: http://embark.rs
• Size: 1.74 MB
• Stars: 101
• Watchers: 6
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# 🔆 superluminal-perf-rs

[![Embark](https://img.shields.io/badge/embark-open%20source-blueviolet.svg)](https://embark.dev)

[![Embark](https://img.shields.io/badge/discord-ark-%237289da.svg?logo=discord)](https://discord.gg/dAuKfZS)

[![Crates.io](https://img.shields.io/crates/v/superluminal-perf.svg)](https://crates.io/crates/superluminal-perf)

[![Docs](https://docs.rs/superluminal-perf/badge.svg)](https://docs.rs/superluminal-perf)

[![dependency status](https://deps.rs/repo/github/EmbarkStudios/superluminal-perf-rs/status.svg)](https://deps.rs/repo/github/EmbarkStudios/superluminal-perf-rs)

[![Build Status](https://github.com/EmbarkStudios/superluminal-perf-rs/workflows/CI/badge.svg)](https://github.com/EmbarkStudios/superluminal-perf-rs/actions?workflow=CI)

[Superluminal Performance](https://superluminal.eu/) profiler Rust API for adding user events to captures.

## How to use

In `Cargo.toml` add:

```toml

[dependencies]

superluminal-perf = "0.3.0"

```

Example usage:

```rust

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](https://img.shields.io/badge/contributor%20covenant-v1.4-ff69b4.svg)](../CODE_OF_CONDUCT.md)

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )

* MIT license ([LICENSE-MIT](LICENSE-MIT) or )

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.