aliased 0.1.5

Rewrite Debug output to replace long opaque values with short human-friendly aliases.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use aliased::AliasContext;
use aliased::contextual::*;

use derive_more::derive::{Deref, Display, From};

fn to_hex(bytes: &[u8]) -> String {
    bytes.iter().map(|b| format!("{:02x}", b)).collect()
}

#[derive(Clone, Copy, Debug, Display, From, Deref)]
#[display("0x{}", to_hex(_0))]
pub struct PublicKey([u8; 32]);

#[derive(Clone, Copy, Debug, Display, From, Deref)]
#[display("0x{}", to_hex(_0))]
pub struct SecretKey([u8; 32]);

#[derive(Clone, Debug)]
pub struct UpstreamStruct {
    secret: SecretKey,
    keys: Vec<PublicKey>,
}

#[derive(Clone, Debug)]
pub struct MyStruct {
    u: UpstreamStruct,
}

fn fixture() -> MyStruct {
    let keys = (0..3).map(|i| PublicKey([i; 32])).collect::<Vec<_>>();
    let sig = SecretKey([0; 32]);
    let upstream = UpstreamStruct { keys, secret: sig };
    MyStruct { u: upstream }
}

#[test]
fn test_nested_names() {
    let ctx = AliasContext::new();
    let s = fixture();

    PublicKey::alias_prefix(&ctx, "K");
    SecretKey::alias_prefix(&ctx, "S");

    s.u.keys[0].alias_named(&ctx, "key-a");
    s.u.keys[1].alias_named(&ctx, "key-b");
    s.u.keys[2].alias_named(&ctx, "key-c");
    s.u.secret.alias_named(&ctx, "secret");

    let d = format!("{:?}", s.aliased(&ctx));
    let p = format!("{:#?}", s.aliased(&ctx));

    assert_eq!(
        d,
        "MyStruct { u: UpstreamStruct { secret: ⟪S|secret⟫, keys: [⟪K|key-a⟫, ⟪K|key-b⟫, ⟪K|key-c⟫] } }"
    );
    assert_eq!(
        p,
        "
MyStruct {
    u: UpstreamStruct {
        secret: ⟪S|secret⟫,
        keys: [
            ⟪K|key-a⟫,
            ⟪K|key-b⟫,
            ⟪K|key-c⟫,
        ],
    },
}
"
        .trim()
    );
}

#[test]
fn test_changing_aliases() {
    let ctx = AliasContext::new();

    PublicKey::alias_prefix(&ctx, "K");
    SecretKey::alias_prefix(&ctx, "S");

    let keys = (0..3)
        .map(|i| *PublicKey([i; 32]).alias_numbered(&ctx))
        .collect::<Vec<_>>();
    let secrets = (0..3)
        .map(|i| *SecretKey([i; 32]).alias_numbered(&ctx))
        .collect::<Vec<_>>();

    assert_eq!(
        format!("{:?}", keys.aliased(&ctx)),
        "[⟪K|#000⟫, ⟪K|#001⟫, ⟪K|#002⟫]"
    );
    assert_eq!(
        format!("{:?}", secrets.aliased(&ctx)),
        "[⟪S|#000⟫, ⟪S|#001⟫, ⟪S|#002⟫]"
    );

    for (i, k) in keys.iter().enumerate() {
        k.alias_named(&ctx, &format!("key-{i}"));
    }

    assert_eq!(
        format!("{:?}", keys.aliased(&ctx)),
        "[⟪K|key-0⟫, ⟪K|key-1⟫, ⟪K|key-2⟫]"
    );
    assert_eq!(
        format!("{:?}", secrets.aliased(&ctx)),
        "[⟪S|#000⟫, ⟪S|#001⟫, ⟪S|#002⟫]"
    );
}