This crate requires a nightly (unstable, experimental) compiler version. To switch to it, you must have Rust installed via Rustup, and run:

rustup default nightly

Run rustup default stable to switch back.

Adding `debug_with_context` library as a dependency

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

cargo add debug_with_context

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

debug_with_context = "0.1.15"

The debug_with_context library will be automatically available globally. Read the debug_with_context library documentation.

Back to the crate overview.

Readme

debug_with_context

A Rust crate for context-aware Debug formatting via a custom derive macro.

Features

#[derive(DebugWithContext)] for structs and enums.
Custom context parameter for formatting.
Works with generics, tuples, options, vectors, and maps.

Requirements

Nightly Rust (#![feature(debug_closure_helpers)])

Usage

Add to your Cargo.toml:

[dependencies]
debug_with_context = "0.1.14"

Example:

#![feature(debug_closure_helpers)]

use debug_with_context::{DebugWithContext, DebugWrapContext};
use std::fmt;

struct Context {
    string_pool : Vec<String>
}

impl Context {
    fn lookup(&self, idx : StringRef) -> &str {
        &self.string_pool[idx.0 as usize]
    }
}

#[derive(Clone, Copy)]
struct StringRef(u32);

impl DebugWithContext<Context> for StringRef {
    fn fmt_with_context(&self, f: &mut fmt::Formatter, context: &Context) -> fmt::Result {
        write!(f, context.lookup(*self))
    }
}

#[derive(DebugWithContext)]
#[debug_context(Context)]
struct MyStruct {
    a: i32,
    b: String,
    c : StringRef,
}

fn main() {
    let ctx = Context {
        string_pool: vec!["test".to_owned()],
    };
    let s = MyStruct { a: 42, b: "hello".to_owned(), c: StringRef(0) };
    println!("{:?}", DebugWrapContext::new(&s, &ctx));
}

License

GPL-3.0

Adding debug_with_context library as a dependency

Adding `debug_with_context` library as a dependency