bebop 3.2.3

The Rust runtime for Bebop, a schema-based binary serialization format.
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
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

use std::fmt::{self, Display, Formatter};
use std::ops::Deref;
use std::str::FromStr;

/// The Microsoft ordering for GUID bytes, where each GUID_MAPPING[i] is the ith byte if stored in
/// big endian format.
const BYTE_MAP: [usize; 16] = [3, 2, 1, 0, 5, 4, 7, 6, 8, 9, 10, 11, 12, 13, 14, 15];

/// A GUID is a unique identifier. Stored internally in the Microsoft Guid format to support
/// zero-copy deserialization
#[derive(Eq, PartialEq, Hash, Clone, Copy, Debug)]
#[repr(transparent)]
pub struct Guid([u8; 16]);

impl Deref for Guid {
    type Target = [u8; 16];

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Display for Guid {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{:02x}{:02x}{:02x}{:02x}-{:02x}{:02x}-{:02x}{:02x}-{:02x}{:02x}-{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}",
            self.0[BYTE_MAP[0]],
            self.0[BYTE_MAP[1]],
            self.0[BYTE_MAP[2]],
            self.0[BYTE_MAP[3]],
            self.0[BYTE_MAP[4]],
            self.0[BYTE_MAP[5]],
            self.0[BYTE_MAP[6]],
            self.0[BYTE_MAP[7]],
            self.0[BYTE_MAP[8]],
            self.0[BYTE_MAP[9]],
            self.0[BYTE_MAP[10]],
            self.0[BYTE_MAP[11]],
            self.0[BYTE_MAP[12]],
            self.0[BYTE_MAP[13]],
            self.0[BYTE_MAP[14]],
            self.0[BYTE_MAP[15]],
        )
    }
}

impl FromStr for Guid {
    type Err = &'static str;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.len() {
            36 => Self::from_str_with_hyphens(s),
            32 => Self::from_str_without_hyphens(s),
            _ => Err("Invalid length, not a GUID"),
        }
    }
}

const GUID_PARSE_ERR: &str = "Failed to parse GUID bytes";

impl Guid {
    /// Convert from a byte array ordered by
    /// https://docs.microsoft.com/en-us/dotnet/api/system.guid.tobytearray?view=net-5.0#System_Guid_ToByteArray
    /// Will just read first 16 bytes
    pub const fn from_ms_bytes(raw: &[u8; 16]) -> Self {
        Self([
            raw[0], raw[1], raw[2], raw[3], raw[4], raw[5], raw[6], raw[7], raw[8], raw[9],
            raw[10], raw[11], raw[12], raw[13], raw[14], raw[15],
        ])
    }

    /// Mimic format produced by
    /// https://docs.microsoft.com/en-us/dotnet/api/system.guid.tobytearray?view=net-5.0#System_Guid_ToByteArray
    pub const fn to_ms_bytes(self) -> [u8; 16] {
        self.0
    }

    fn from_str_without_hyphens(s: &str) -> Result<Self, &'static str> {
        let mut buf = [0u8; 16];
        // this is inefficient because of the unicode representation used by Rust but probably
        // fine for now
        for i in 0..16 {
            if let Ok(v) = u8::from_str_radix(&s[i * 2..i * 2 + 2], 16) {
                buf[BYTE_MAP[i]] = v
            } else {
                return Err(GUID_PARSE_ERR);
            }
        }
        Ok(Guid(buf))
    }

    #[inline]
    fn from_str_with_hyphens(s: &str) -> Result<Self, &'static str> {
        // avoid extra copy
        let without_hyphens: String = s.split('-').collect();
        Self::from_str_without_hyphens(&without_hyphens)
    }

    pub const fn from_le_bytes(b: [u8; 16]) -> Self {
        Self([
            b[15 - BYTE_MAP[0]],
            b[15 - BYTE_MAP[1]],
            b[15 - BYTE_MAP[2]],
            b[15 - BYTE_MAP[3]],
            b[15 - BYTE_MAP[4]],
            b[15 - BYTE_MAP[5]],
            b[15 - BYTE_MAP[6]],
            b[15 - BYTE_MAP[7]],
            b[15 - BYTE_MAP[8]],
            b[15 - BYTE_MAP[9]],
            b[15 - BYTE_MAP[10]],
            b[15 - BYTE_MAP[11]],
            b[15 - BYTE_MAP[12]],
            b[15 - BYTE_MAP[13]],
            b[15 - BYTE_MAP[14]],
            b[15 - BYTE_MAP[15]],
        ])
    }

    /// Get the little endian bytes of this GUID.
    pub const fn to_le_bytes(self) -> [u8; 16] {
        [
            self.0[BYTE_MAP[15]],
            self.0[BYTE_MAP[14]],
            self.0[BYTE_MAP[13]],
            self.0[BYTE_MAP[12]],
            self.0[BYTE_MAP[11]],
            self.0[BYTE_MAP[10]],
            self.0[BYTE_MAP[9]],
            self.0[BYTE_MAP[8]],
            self.0[BYTE_MAP[7]],
            self.0[BYTE_MAP[6]],
            self.0[BYTE_MAP[5]],
            self.0[BYTE_MAP[4]],
            self.0[BYTE_MAP[3]],
            self.0[BYTE_MAP[2]],
            self.0[BYTE_MAP[1]],
            self.0[BYTE_MAP[0]],
        ]
    }

    pub const fn from_be_bytes(b: [u8; 16]) -> Self {
        Self([
            b[BYTE_MAP[0]],
            b[BYTE_MAP[1]],
            b[BYTE_MAP[2]],
            b[BYTE_MAP[3]],
            b[BYTE_MAP[4]],
            b[BYTE_MAP[5]],
            b[BYTE_MAP[6]],
            b[BYTE_MAP[7]],
            b[BYTE_MAP[8]],
            b[BYTE_MAP[9]],
            b[BYTE_MAP[10]],
            b[BYTE_MAP[11]],
            b[BYTE_MAP[12]],
            b[BYTE_MAP[13]],
            b[BYTE_MAP[14]],
            b[BYTE_MAP[15]],
        ])
    }

    /// Get the big endian bytes of this GUID.
    pub const fn to_be_bytes(self) -> [u8; 16] {
        [
            self.0[BYTE_MAP[0]],
            self.0[BYTE_MAP[1]],
            self.0[BYTE_MAP[2]],
            self.0[BYTE_MAP[3]],
            self.0[BYTE_MAP[4]],
            self.0[BYTE_MAP[5]],
            self.0[BYTE_MAP[6]],
            self.0[BYTE_MAP[7]],
            self.0[BYTE_MAP[8]],
            self.0[BYTE_MAP[9]],
            self.0[BYTE_MAP[10]],
            self.0[BYTE_MAP[11]],
            self.0[BYTE_MAP[12]],
            self.0[BYTE_MAP[13]],
            self.0[BYTE_MAP[14]],
            self.0[BYTE_MAP[15]],
        ]
    }
}

#[cfg(test)]
const BYTES_BE: [u8; 16] = [
    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
];
#[cfg(test)]
const BYTES_LE: [u8; 16] = [
    0x0f, 0x0e, 0x0d, 0x0c, 0x0b, 0x0a, 0x09, 0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00,
];
#[cfg(test)]
const BYTES_MS: [u8; 16] = [
    0x03, 0x02, 0x01, 0x00, 0x05, 0x04, 0x07, 0x06, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
];
#[cfg(test)]
const BYTES_STR: &str = "00010203-0405-0607-0809-0a0b0c0d0e0f";
#[cfg(test)]
const BYTES_STR_NO_HYPH: &str = "000102030405060708090a0b0c0d0e0f";

#[test]
fn from_ms_bytes() {
    assert_eq!(Guid::from_ms_bytes(&BYTES_MS).0, BYTES_MS);
}

#[test]
fn to_ms_bytes() {
    assert_eq!(Guid(BYTES_MS).to_ms_bytes(), BYTES_MS);
}

#[test]
fn from_le_bytes() {
    assert_eq!(Guid::from_le_bytes(BYTES_LE).0, BYTES_MS);
}

#[test]
fn to_le_bytes() {
    assert_eq!(Guid(BYTES_MS).to_le_bytes(), BYTES_LE);
}

#[test]
fn from_be_bytes() {
    assert_eq!(Guid::from_be_bytes(BYTES_BE).0, BYTES_MS);
}

#[test]
fn to_be_bytes() {
    assert_eq!(Guid(BYTES_MS).to_be_bytes(), BYTES_BE);
}

#[test]
fn from_str() {
    assert_eq!(Guid::from_str(BYTES_STR).unwrap().0, BYTES_MS);
    assert_eq!(Guid::from_str(BYTES_STR_NO_HYPH).unwrap().0, BYTES_MS);
    assert_eq!(Guid::from_str_with_hyphens(BYTES_STR).unwrap().0, BYTES_MS);
    assert_eq!(
        Guid::from_str_without_hyphens(BYTES_STR_NO_HYPH).unwrap().0,
        BYTES_MS
    );
}

#[test]
fn to_str() {
    assert_eq!(Guid(BYTES_MS).to_string(), BYTES_STR);
}