dcbor/
dump.rs

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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
import_stdlib!();

use crate::{tags_store::TagsStoreTrait, with_tags, CBORCase, CBOR};

use super::{string_util::{sanitized, flanked}, varint::{EncodeVarInt, MajorType}};

/// Affordances for viewing the encoded binary representation of CBOR as hexadecimal.
impl CBOR {
    /// Returns the encoded hexadecimal representation of this CBOR.
    pub fn hex(&self) -> String {
        hex::encode(self.to_cbor_data())
    }

    /// Returns the encoded hexadecimal representation of this CBOR.
    ///
    /// Optionally annotates the output, e.g. breaking the output up into
    /// semantically meaningful lines, formatting dates, and adding names of
    /// known tags.
    pub fn hex_opt(&self, annotate: bool, tags: Option<&dyn TagsStoreTrait>) -> String {
        if !annotate {
            return self.hex()
        }
        let items = self.dump_items(0, tags);
        let note_column = items.iter().fold(0, |largest, item| {
            largest.max(item.format_first_column().len())
        });
        // Round up to nearest multiple of 4
        let note_column = ((note_column + 4) & !3) - 1;
        let lines: Vec<_> = items.iter().map(|x| x.format(note_column)).collect();
        lines.join("\n")
    }

    /// Returns the encoded hexadecimal representation of this CBOR, with annotations.
    pub fn hex_annotated(&self) -> String {
        with_tags!(|tags: &dyn TagsStoreTrait| {
            self.hex_opt(true, Some(tags))
        })
    }

    fn dump_items(&self, level: usize, tags: Option<&dyn TagsStoreTrait>) -> Vec<DumpItem> {
        match self.as_case() {
            CBORCase::Unsigned(n) => vec!(DumpItem::new(level, vec!(self.to_cbor_data()), Some(format!("unsigned({})", n)))),
            CBORCase::Negative(n) => vec!(DumpItem::new(level, vec!(self.to_cbor_data()), Some(format!("negative({})", -1 - (*n as i128))))),
            CBORCase::ByteString(d) => {
                let mut items = vec![
                    DumpItem::new(level, vec!(d.len().encode_varint(MajorType::ByteString)), Some(format!("bytes({})", d.len())))
                ];
                if !d.is_empty() {
                    let mut note: Option<String> = None;
                    if let Ok(a) = str::from_utf8(d) {
                        if let Some(b) = sanitized(a) {
                            note = Some(flanked(&b, "\"", "\""));
                        }
                    }
                    items.push(DumpItem::new(level + 1, vec!(d.to_vec()), note));
                }
                items
            },
            CBORCase::Text(s) => {
                let header = s.len().encode_varint(MajorType::Text);
                let header_data = vec![vec!(header[0]), header[1..].to_vec()];
                let utf8_data = s.as_bytes().to_vec();
                vec![
                    DumpItem::new(level, header_data, Some(format!("text({})", utf8_data.len()))),
                    DumpItem::new(level + 1, vec![utf8_data], Some(flanked(s, "\"", "\"")))
                ]
            },
            CBORCase::Simple(v) => {
                let data = v.cbor_data();
                let note = format!("{}", v);
                vec![
                    DumpItem::new(level, vec![data], Some(note))
                ]
            },
            CBORCase::Tagged(tag, item) => {
                let header = tag.value().encode_varint(MajorType::Tagged);
                let header_data = vec![vec!(header[0]), header[1..].to_vec()];
                let mut note_components: Vec<String> = vec![format!("tag({})", tag.value())];
                if let Some(tags) = tags {
                    if let Some(name) = tags.assigned_name_for_tag(tag) {
                        note_components.push(name);
                    }
                }
                let tag_note = note_components.join(" ");
                vec![
                    vec![
                        DumpItem::new(level, header_data, Some(tag_note))
                    ],
                    item.dump_items(level + 1, tags)
                ].into_iter().flatten().collect()
            },
            CBORCase::Array(array) => {
                let header = array.len().encode_varint(MajorType::Array);
                let header_data = vec![vec!(header[0]), header[1..].to_vec()];
                vec![
                    vec![
                        DumpItem::new(level, header_data, Some(format!("array({})", array.len())))
                    ],
                    array.iter().flat_map(|x| x.dump_items(level + 1, tags)).collect()
                ].into_iter().flatten().collect()
            },
            CBORCase::Map(m) => {
                let header = m.len().encode_varint(MajorType::Map);
                let header_data = vec![vec!(header[0]), header[1..].to_vec()];
                vec![
                    vec![
                        DumpItem::new(level, header_data, Some(format!("map({})", m.len())))
                    ],
                    m.iter().flat_map(|x| {
                        vec![
                            x.0.dump_items(level + 1, tags),
                            x.1.dump_items(level + 1, tags)
                        ].into_iter().flatten().collect::<Vec<DumpItem>>()
                    }).collect()
                ].into_iter().flatten().collect()
            },
        }
    }
}

#[derive(Debug)]
struct DumpItem {
    level: usize,
    data: Vec<Vec<u8>>,
    note: Option<String>,
}

impl DumpItem {
    fn new(level: usize, data: Vec<Vec<u8>>, note: Option<String>) -> DumpItem {
        DumpItem { level, data, note }
    }

    fn format(&self, note_column: usize) -> String {
        let column_1 = self.format_first_column();
        let (column_2, padding) = {
            if let Some(note) = &self.note {
                let padding_count = 1.max(39.min(note_column as i64) - (column_1.len() as i64) + 1);
                let padding = " ".repeat(padding_count.try_into().unwrap());
                let column_2 = format!("# {}", note);
                (column_2, padding)
            } else {
                ("".to_string(), "".to_string())
            }
        };
        column_1 + &padding + &column_2
    }

    fn format_first_column(&self) -> String {
        let indent = " ".repeat(self.level * 4);
        let hex: Vec<_> = self.data.iter()
            .map(hex::encode)
            .filter(|x| !x.is_empty())
            .collect();
        let hex = hex.join(" ");
        indent + &hex
    }
}