performance-mark-macro is a procedural macro. It will run at compile time and transform your program's source code.

Adding `performance-mark-macro` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add performance-mark-macro

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

performance-mark-macro = "0.2.2"

You may need to import the macro(s) with use performance_mark_macro::*.

Read the performance_mark_macro documentation.

Back to the crate overview.

Readme

Performance Mark

performance_mark is an attribute macro that adds performance (time) logging to functions. By default, it uses println!, but can be configured to use a custom method.

Basic example:

use performance_mark_attribute::performance_mark;

#[performance_mark]
fn test_function_logged_using_stdout() {
   println!("Hello!");
}

Output:

(performance_mark) test_function_logged_using_stdout took 7.177µs

Custom Logging Method

use performance_mark_attribute::{performance_mark, LogContext}

#[performance_mark(log_with_this)]
fn test_function_logged_using_custom_function() {
   println!("Hello!");
}

fn log_with_this(ctx: LogContext) {
    println!("Function: {} , Time: {}ms", ctx.function, ctx.duration);
}

Custom Async Logging Method

use performance_mark_attribute::{performance_mark, LogContext}

#[performance_mark(async log_with_this)]
fn test_function_logged_using_custom_function() {
   println!("Hello!");
}

async fn log_with_this(ctx: LogContext) {
    // Log asynchronously
}

Adding performance-mark-macro macro(s) as a dependency

Adding `performance-mark-macro` macro(s) as a dependency