bitcoinleveldb-versionedit 0.1.19

LevelDB-compatible VersionEdit encoding/decoding and manipulation utilities used by bitcoin-rs for manifest and version metadata management.
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

// ---------------- [ File: bitcoinleveldb-versionedit/src/versionedit_debug_string.rs ]
crate::ix!();

impl VersionEdit {

    pub fn debug_string(&self) -> String {
        trace!("VersionEdit::debug_string: generating human-readable summary");

        let mut r = String::from("VersionEdit {");

        if *self.has_comparator() {
            r.push_str("\n  Comparator: ");
            r.push_str(self.comparator());
        }
        if *self.has_log_number() {
            r.push_str("\n  LogNumber: ");
            r.push_str(&self.log_number().to_string());
        }
        if *self.has_prev_log_number() {
            r.push_str("\n  PrevLogNumber: ");
            r.push_str(&self.prev_log_number().to_string());
        }
        if *self.has_next_file_number() {
            r.push_str("\n  NextFile: ");
            r.push_str(&self.next_file_number().to_string());
        }
        if *self.has_last_sequence() {
            r.push_str("\n  LastSeq: ");
            r.push_str(&self.last_sequence().to_string());
        }

        for (level, key) in self.compact_pointers() {
            r.push_str("\n  CompactPointer: ");
            r.push_str(&level.to_string());
            r.push(' ');
            r.push_str(&key.debug_string());
        }

        for (level, number) in self.deleted_files() {
            r.push_str("\n  DeleteFile: ");
            r.push_str(&level.to_string());
            r.push(' ');
            r.push_str(&number.to_string());
        }

        for (level, f) in self.new_files() {
            r.push_str("\n  AddFile: ");
            r.push_str(&level.to_string());
            r.push(' ');
            r.push_str(&f.number().to_string());
            r.push(' ');
            r.push_str(&f.file_size().to_string());
            r.push(' ');
            r.push_str(&f.smallest().debug_string());
            r.push_str(" .. ");
            r.push_str(&f.largest().debug_string());
        }

        r.push_str("\n}\n");

        r
    }
}

#[cfg(test)]
mod version_edit_debug_string_tests {
    use super::*;

    #[traced_test]
    fn debug_string_includes_all_set_fields_and_file_changes() {
        trace!("debug_string_includes_all_set_fields_and_file_changes: start");

        const K_BIG: u64 = 1u64 << 40;

        let mut edit = VersionEdit::default();

        let cmp_name  = String::from("cmp");
        let cmp_slice = Slice::from(&cmp_name);
        edit.set_comparator_name(&cmp_slice);
        edit.set_log_number(K_BIG + 1);
        edit.set_prev_log_number(K_BIG + 2);
        edit.set_next_file(K_BIG + 3);
        edit.set_last_sequence((K_BIG + 4) as SequenceNumber);

        let user_smallest = Slice::from("a".as_bytes());
        let user_largest  = Slice::from("z".as_bytes());

        let smallest = InternalKey::new(
            &user_smallest,
            (K_BIG + 5) as SequenceNumber,
            ValueType::TypeValue,
        );
        let largest = InternalKey::new(
            &user_largest,
            (K_BIG + 6) as SequenceNumber,
            ValueType::TypeValue,
        );

        edit.add_file(1, K_BIG + 7, K_BIG + 8, &smallest, &largest);
        edit.delete_file(2, K_BIG + 9);

        let compact_key = InternalKey::new(
            &Slice::from("x".as_bytes()),
            (K_BIG + 10) as SequenceNumber,
            ValueType::TypeValue,
        );
        edit.set_compact_pointer(3, &compact_key);

        let dbg = edit.debug_string();
        debug!(debug_string = %dbg, "version_edit debug_string output");

        assert!(
            dbg.contains("Comparator: cmp"),
            "debug_string should contain comparator name"
        );
        assert!(
            dbg.contains("LogNumber:"),
            "debug_string should contain LogNumber"
        );
        assert!(
            dbg.contains("PrevLogNumber:"),
            "debug_string should contain PrevLogNumber"
        );
        assert!(
            dbg.contains("NextFile:"),
            "debug_string should contain NextFile"
        );
        assert!(
            dbg.contains("LastSeq:"),
            "debug_string should contain LastSeq"
        );
        assert!(
            dbg.contains("CompactPointer:"),
            "debug_string should contain CompactPointer entries"
        );
        assert!(
            dbg.contains("DeleteFile:"),
            "debug_string should contain DeleteFile entries"
        );
        assert!(
            dbg.contains("AddFile:"),
            "debug_string should contain AddFile entries"
        );
    }
}