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
54
55
56
57
58
59

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

use sensitive_fmt::{SensitiveDebug, SensitiveDisplay};

#[derive(SensitiveDebug, SensitiveDisplay)]
struct Account {
    id: u64,
    #[sensitive(redact)]
    _email: String,
    #[sensitive(redact)]
    _password: String,
}

/// A type with no Debug or Display impl. If `redact` truly drops the trait
/// requirement, this struct should still compile.
struct NotFormattable;

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

#[test]
fn redact_in_debug() {
    let a = Account {
        id: 1,
        _email: "alice@example.com".into(),
        _password: "hunter2".into(),
    };
    assert_eq!(
        format!("{a:?}"),
        "Account { id: 1, _email: REDACTED, _password: REDACTED }",
    );
}

#[test]
fn redact_in_display() {
    let a = Account {
        id: 1,
        _email: "alice@example.com".into(),
        _password: "hunter2".into(),
    };
    assert_eq!(
        format!("{a}"),
        "Account { id: 1, _email: REDACTED, _password: REDACTED }",
    );
}

#[test]
fn redact_drops_trait_bound() {
    let w = WithUnformattable {
        id: 7,
        _raw: NotFormattable,
    };
    assert_eq!(format!("{w:?}"), "WithUnformattable { id: 7, _raw: REDACTED }");
    assert_eq!(format!("{w}"), "WithUnformattable { id: 7, _raw: REDACTED }");
}