sensitive-fmt 0.2.0

Derive Debug and Display while honoring #[sensitive(redact | truncate = N | skip)] field attributes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! `#[sensitive(skip)]` field attribute.

use sensitive_fmt::{SensitiveDebug, SensitiveDisplay};

struct NotFormattable;

#[derive(SensitiveDebug, SensitiveDisplay)]
struct Record {
    id: u64,
    #[sensitive(skip)]
    _raw: NotFormattable,
}

#[test]
fn skip_in_debug() {
    let r = Record {
        id: 1,
        _raw: NotFormattable,
    };
    assert_eq!(format!("{r:?}"), "Record { id: 1, _raw: <skipped> }");
}

#[test]
fn skip_in_display() {
    let r = Record {
        id: 1,
        _raw: NotFormattable,
    };
    assert_eq!(format!("{r}"), "Record { id: 1, _raw: <skipped> }");
}

/// A struct that uses both #[sensitive(redact)] and #[sensitive(skip)] on
/// different fields. Confirms the two modifiers coexist correctly — both
/// marker enum variants are in scope inside the same generated `fmt` body.
#[derive(SensitiveDebug, SensitiveDisplay)]
struct Mixed {
    id: u64,
    #[sensitive(redact)]
    _token: String,
    #[sensitive(skip)]
    _raw: NotFormattable,
}

#[test]
fn redact_and_skip_coexist_in_one_struct() {
    let m = Mixed {
        id: 1,
        _token: "secret".into(),
        _raw: NotFormattable,
    };
    assert_eq!(format!("{m:?}"), "Mixed { id: 1, _token: REDACTED, _raw: <skipped> }",);
    assert_eq!(format!("{m}"), "Mixed { id: 1, _token: REDACTED, _raw: <skipped> }",);
}