aliased 0.1.4

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

use std::collections::BTreeMap;

#[allow(unused)]
fn main() {
    use aliased::*;

    #[derive(Clone, Copy, Debug, Ord, PartialOrd, Eq, PartialEq)]
    struct ContentHash([u8; 32]);

    #[derive(Clone, Debug)]
    struct ContentBlob(Vec<u8>);

    #[derive(Clone, Debug)]
    struct Uuid(String);

    ContentHash::alias_prefix("H");
    ContentBlob::alias_prefix("Blob");
    Uuid::alias_prefix("UUID");

    let hash_a = ContentHash([1; 32]);
    let hash_b = ContentHash([2; 32]);
    let hash_c = ContentHash([3; 32]);

    let blob_a = ContentBlob(vec![4; 256]);
    let blob_b = ContentBlob(vec![5; 256]);
    let blob_c = ContentBlob(vec![6; 256]);

    let uuid1 = "123e4567-e89b-12d3-a456-426614174000".to_string();
    let uuid2 = "123e4567-e89b-12d3-a456-426614174001".to_string();
    let d = Uuid(uuid1.clone());
    let e = Uuid(uuid2.clone());

    #[derive(Debug)]
    struct ComplexShape {
        uuids: Vec<Uuid>,
        content: BTreeMap<ContentHash, ContentBlob>,
        description: String,
    }

    let shape = ComplexShape {
        uuids: vec![d.clone(), e.clone()],
        content: BTreeMap::from([
            (hash_a, blob_a.clone()),
            (hash_b, blob_b.clone()),
            (hash_c, blob_c.clone()),
        ]),
        description: format!(
            "Here's some text that gets untouched and even contains one of the aliased UUIDs ({uuid1})"
        ),
    };

    println!("Without aliases, this is thousands of lines long!");
    println!("```");
    dbg!(shape.aliased());
    println!("```");

    println!();
    println!();
    println!("You probably can't even find the beginning of the output above.");

    hash_a.alias_named("a");
    hash_b.alias_named("b");
    hash_c.alias_named("c");
    blob_a.alias_named("a");
    blob_b.alias_named("b");
    blob_c.alias_named("c");
    d.alias_numbered();
    e.alias_numbered();

    println!("However, with aliases, this is a very readable 12 lines:");
    println!();
    println!("```");
    dbg!(shape.aliased());
    println!("```");

    pretty_assertions::assert_eq!(format!("{:#?}", shape.aliased()), 
r#"
ComplexShape {
    uuids: [
        ⟪UUID|#000⟫,
        ⟪UUID|#001⟫,
    ],
    content: {
        ⟪H|a⟫: ⟪Blob|a⟫,
        ⟪H|b⟫: ⟪Blob|b⟫,
        ⟪H|c⟫: ⟪Blob|c⟫,
    },
    description: "Here's some text that gets untouched and even contains one of the aliased UUIDs (123e4567-e89b-12d3-a456-426614174000)",
}
"#.trim()
);
}