Crate spannify

Spannify

This crate provides functionality to produce nice-looking graphs that represent your callstack. It is designed to help developers trace and understand the execution flow of their programs, making it easier to debug and optimize their code.

Overview

The core functionality of this crate revolves around creating spans that represent different sections of your code. These spans are organized hierarchically, and the crate generates messages to visualize when you enter and exit each span. The generated messages can be customized to suit your preferences using a variety of configuration options.

Modules

• config: Contains the configuration structures and options for customizing the appearance and behavior of the callstack visualization.
• core: Contains the core functionality for managing spans, generating messages, and handling the callstack visualization logic.
• level: Contains the levels of spans, which determines if the span should be outputted or not

Example

use spannify::{config::Config, core::StdoutSpanner, spf};
use std::sync::LazyLock;

static SPANNER: LazyLock<StdoutSpanner> =
    LazyLock::new(|| StdoutSpanner::new().with_config(Config::new().with_skip(1)));

fn fib(n: usize) -> usize {
    let _span = spf!(SPANNER, "fib({n})");
    match n {
        0 => 0,
        1 | 2 => 1,
        _ => fib(n - 1) + fib(n - 2),
    }
}

fn main() {
    fib(5);
}

Output

┌fib(5)
|  fib(4)
|   ┌fib(3)
|   ┆  fib(2)
|   ┆  fib(2)
|   ┆  fib(1)
|   ┆  fib(1)
|   └fib(3)
|   ┌fib(2)
|   └fib(2)
|  fib(4)
|  fib(3)
|   ┌fib(2)
|   └fib(2)
|   ┌fib(1)
|   └fib(1)
|  fib(3)
└fib(5)

Usage

To use this crate, you typically start by creating a spannify instance with a desired writer and configuration. Then, you create spans by calling the Span::enter method, which tracks the entry and exit points of different sections of your code.

use spannify::{config::Config, core::{StdoutSpanner}};
use std::io::stdout;

// Create a configuration
let config = Config::default();

// Create a spannify
let spanner = StdoutSpanner::new().with_config(config);

// Create a span
{
    let _span = spanner.enter_span("main");
    // Your code here...
}
// The span is automatically dropped here, and the exit message is generated

Configuration

The config module provides various options to customize the appearance and behavior of the callstack visualization. This includes settings for indentation, depth display, and message formatting. You can create a custom configuration by modifying the default values.

use spannify::config::Config;

let mut config = Config::default();
config.tabwidth = 4;
config.skip = 2;
config.depthmap = |depth| if depth % 2 == 0 { '|' } else { '^' };

// Use this configuration when creating a spannify

License

This crate is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request

Modules

config

Configuration for span generators

core

Span and span generators

level

Span levels

Macros

spf

Creates a new span with a given spanner.