7 unstable 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.3.0 Feb 1, 2020

#20 in Value formatting

Download history 12670/week @ 2024-09-20 13471/week @ 2024-09-27 14151/week @ 2024-10-04 16167/week @ 2024-10-11 18109/week @ 2024-10-18 18380/week @ 2024-10-25 18278/week @ 2024-11-01 19108/week @ 2024-11-08 14629/week @ 2024-11-15 16227/week @ 2024-11-22 20673/week @ 2024-11-29 22168/week @ 2024-12-06 19143/week @ 2024-12-13 9263/week @ 2024-12-20 6409/week @ 2024-12-27 13711/week @ 2025-01-03

52,546 downloads per month
Used in 63 crates (22 directly)

Apache-2.0 OR MIT

7KB
81 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–1.1MB
~24K SLoC