debug-ignore
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
Debugby hand. derivativehas greater control over the behavior ofDebugimpls, 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.
1 Oct 31, 2021
1 Oct 28, 2021
3 Feb 7, 2022
274 Dec 29, 2022
220 Dec 26, 2022
11 Nov 30, 2022
3 Sep 17, 2022
14 Dec 29, 2022
7 Jan 7, 2023
7 Dec 18, 2022
6 Jun 17, 2022
4 Jul 20, 2022
2 Sep 19, 2022
16 Mar 6, 2023
3 Jul 9, 2023
628 Jan 7, 2023
80 Sep 8, 2022
50 Dec 10, 2022
22 Nov 20, 2022