#no-std

no-std debug-ignore

A newtype wrapper that causes a field to be skipped while printing out Debug output

4 stable releases

Uses old Rust 2015

1.0.3 Aug 31, 2022
1.0.2 Mar 14, 2022
1.0.1 Oct 1, 2021

#175 in Debugging

Download history 16599/week @ 2022-08-18 14080/week @ 2022-08-25 13365/week @ 2022-09-01 14314/week @ 2022-09-08 12425/week @ 2022-09-15 13679/week @ 2022-09-22 16069/week @ 2022-09-29 17871/week @ 2022-10-06 16285/week @ 2022-10-13 19120/week @ 2022-10-20 17857/week @ 2022-10-27 18352/week @ 2022-11-03 15397/week @ 2022-11-10 15596/week @ 2022-11-17 13433/week @ 2022-11-24 15870/week @ 2022-12-01

62,962 downloads per month
Used in 14 crates (5 directly)

MIT/Apache

12KB
68 lines

debug-ignore

debug-ignore on crates.io Documentation (latest release) Documentation (main) License License

This library contains DebugIgnore, a newtype wrapper that causes a field to be skipped while printing out Debug output.

Examples

use debug_ignore::DebugIgnore;

// Some structs have many fields with large `Debug` implementations.
#[derive(Debug)]
struct InnerStructWithLotsOfDebugInfo {
    field: &'static str,
    // ...
}

#[derive(Debug)]
pub struct PublicStruct {
    inner: DebugIgnore<InnerStructWithLotsOfDebugInfo>,
}

impl PublicStruct {
    pub fn new() -> Self {
        Self {
            inner: DebugIgnore(InnerStructWithLotsOfDebugInfo { field: "field", /* ... */ })
        }
    }
}

let x = PublicStruct::new();
assert_eq!(format!("{:?}", x), "PublicStruct { inner: ... }");

// Fields within inner can still be accessed through the Deref impl.
assert_eq!(x.inner.field, "field");

Why?

Some structs have many fields with large Debug implementations. It can be really annoying to go through a ton of usually irrelevant Debug output.

DebugIgnore is a zero-cost, zero-compile-time way to achieve a Debug impl that skips over a field.

Optional features

serde: serde support with #[serde(transparent)].

Rust version support

The MSRV is Rust 1.34 though this crate likely builds with older versions. This crate is too trivial to require anything more recent.

Optional features may require newer versions of Rust.

Alternatives

  • Implement Debug by hand.
  • derivative has greater control over the behavior of Debug impls, at the cost of a compile-time proc-macro dependency.

Contributing

Pull requests are welcome! Please follow the code of conduct.

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.

Dependencies

~160KB