16 releases

0.6.2 Nov 26, 2024
0.6.1 Jan 22, 2024
0.5.1 Mar 11, 2023
0.5.0 Jun 12, 2020
0.1.4 Nov 27, 2018

#804 in Procedural macros

Download history 20960/week @ 2024-11-27 25648/week @ 2024-12-04 23057/week @ 2024-12-11 16038/week @ 2024-12-18 6109/week @ 2024-12-25 13577/week @ 2025-01-01 20685/week @ 2025-01-08 16567/week @ 2025-01-15 19837/week @ 2025-01-22 20967/week @ 2025-01-29 24364/week @ 2025-02-05 20359/week @ 2025-02-12 20645/week @ 2025-02-19 14226/week @ 2025-02-26 16066/week @ 2025-03-05 12926/week @ 2025-03-12

67,762 downloads per month
Used in 95 crates (15 directly)

Apache-2.0 OR MIT

23KB
546 lines

custom_debug

Derive Debug with a custom format per field.

Example usage

Here is a showcase of custom_debugs features:

    use custom_debug::Debug;
    use std::fmt;

    #[derive(Debug)]
    struct Foo {
        #[debug(format = "{} things")]
        x: i32,
        #[debug(skip)]
        y: i32,
        #[debug(with = hex_fmt)]
        z: i32,
        #[debug(skip_if = Option::is_none)]
        label: Option<String>,
    }

    fn hex_fmt<T: fmt::Debug>(n: &T, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "0x{:02X?}", n)
    }

The resulting debug output would look something like this:

Foo {
    x: 42 things,
    z: 0xAB
}

Field attributes reference

Attributes within a section below are considered mutually exclusive.

Skip attributes

skip Unconditionally skips a field.
skip_if = path::to::function Skips a field if path::to::function(&field) returns true.

Format attributes

format = "format string {}" Formats a field using a format string. Must contain a placeholder ({}) with modifiers of your choice.
with = path::to::formatter Formats a field using path::to::formatter. The required signature is fn(&T, &mut std::fmt::Formatter) -> std::fmt::Result where T is a type compatible with the field's type (i.e. the function can be generic and coercions apply).

Dependencies

~0.6–1MB
~23K SLoC