tycho 0.1.2

A minimal, self-describing and traversable binary data format designed around rust and the serde data model.
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

use std::fmt;

#[derive(Clone, Ord, PartialOrd, Eq, PartialEq)]
/// A simple UUID (v4) implementation.
///
/// Rather than using the `uuid` crate, tycho has it's own implementation of uuids
/// for better handling between serde and elements.
///
///
pub struct Uuid(u128);

impl Uuid {
    /// Create a new uuid (any version) using a random number
    pub fn new() -> Self {
        Self(rand::random())
    }

    /// Create a new v4 (typed) uuid with a random number.
    pub fn v4() -> Self {
        Self((
            rand::random::<u128>()
                & 0xffffffff_ffff_0fff_ffff_ffffffffffffu128)
            | 0x00000000_0000_4000_0000_000000000000u128)
    }

    /// Get the hex representation of the uuid (no hyphens)
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_numeric(62911151285467627956781226334379231326);
    ///
    /// assert_eq!(uuid.hex(), "2f543f3c06594e9233b0c8a85c2ac85e");
    /// ```
    pub fn hex(&self) -> String {
        format!("{:032x?}", self.0)
    }

    /// Get the formated hex representation of the uuid (with hyphens)
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_numeric(62911151285467627956781226334379231326);
    ///
    /// assert_eq!(uuid.string(), "2f543f3c-0659-4e92-33b0-c8a85c2ac85e");
    /// ```
    pub fn string(&self) -> String {
        let mut hex = self.hex();
        hex.insert(8, '-');
        hex.insert(13, '-');
        hex.insert(18, '-');
        hex.insert(23, '-');
        hex
    }

    /// Get the numerical representation of the uuid as a unsigned 128-bit number.
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_string("2f543f3c-0659-4e92-33b0-c8a85c2ac85e").unwrap();
    ///
    /// assert_eq!(uuid.numeric(), 62911151285467627956781226334379231326);
    /// ```
    pub fn numeric(&self) -> u128 {
        self.0
    }

    /// Get the bytes representation of a uuid.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_string("2f543f3c-0659-4e92-33b0-c8a85c2ac85e").unwrap();
    /// assert_eq!(uuid.bytes(), vec![47, 84, 63, 60, 6, 89, 78, 146, 51, 176, 200, 168, 92, 42, 200, 94]);
    /// ```
    pub fn bytes(&self) -> Vec<u8> { self.0.to_be_bytes().to_vec() }

    /// Get the slice of the bytes representation of a uuid.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_string("2f543f3c-0659-4e92-33b0-c8a85c2ac85e").unwrap();
    /// assert_eq!(uuid.slice(), [47, 84, 63, 60, 6, 89, 78, 146, 51, 176, 200, 168, 92, 42, 200, 94]);
    /// ```
    pub fn slice(&self) -> [u8; 16] { self.0.to_be_bytes() }


    /// Get a null (0 value) uuid.
    ///
    /// `00000000-0000-0000-0000-000000000000`
    pub fn nil() -> Self {
        Self(0)
    }

    /// Check if the uuid is nil, a value of 0.
    /// ```
    /// use tycho::Uuid;
    ///
    /// let uuid = Uuid::nil();
    /// assert_eq!(uuid.is_nil(), true);
    /// ```
    pub fn is_nil(&self) -> bool {
        self.0 == 0
    }

    /// Get the version number of a uuid as an u8.
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_numeric(62911151285467627956781226334379231326);
    ///
    /// assert_eq!(uuid.version(), 4);
    /// ```
    pub fn version(&self) -> u8 {
        ((self.0 & 0x00000000_0000_f000_0000_000000000000u128) >> 76) as u8
    }

    /// Create an uuid from a numerical value.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_numeric(62911151285467627956781226334379231326);
    ///
    /// assert_eq!(uuid.hex(), "2f543f3c06594e9233b0c8a85c2ac85e");
    /// ```
    pub fn from_numeric(x: u128) -> Self {
        Self(x)
    }

    /// Create a uuid from an unformatted 32 length hex string.
    ///
    /// Returns none on failure.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_hex("2f543f3c06594e9233b0c8a85c2ac85e").unwrap();
    ///
    /// assert_eq!(uuid.hex(), "2f543f3c06594e9233b0c8a85c2ac85e");
    /// ```
    pub fn from_hex(x: &str) -> Option<Self> {
        Some(Self(u128::from_str_radix(x, 16).ok()?))
    }

    /// Create a uuid from an formatted 32 length hex string.
    ///
    /// Returns none on failure.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_string("2f543f3c-0659-4e92-33b0-c8a85c2ac85e").unwrap();
    /// assert_eq!(uuid.hex(), "2f543f3c06594e9233b0c8a85c2ac85e");
    /// ```
    pub fn from_string(x: &str) -> Option<Self> {
        Self::from_hex(&x.replace("-", ""))
    }

    /// Try to create a uuid from any string.
    ///
    /// This function strips all non-hex characters and trims length of string.
    ///
    /// If it fails, it returns a nil uuid.
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_string_lossy("2<f54>??z3f3c-0659-[4]e92_33b0-c8a85opolc2ac85e@bbc.co.uk");
    ///
    /// assert_eq!(uuid.hex(), "2f543f3c06594e9233b0c8a85c2ac85e");
    /// ```
    pub fn from_string_lossy(x: &str) -> Self {
        let mut y = x.chars().filter(|x|
                   x == &'0' || x == &'1' || x == &'2' || x == &'3'

                || x == &'4' || x == &'5' || x == &'6' || x == &'7'
                || x == &'8' || x == &'9' || x == &'a' || x == &'b'
                || x == &'c' || x == &'d' || x == &'e' || x == &'f' )
            .collect::<String>();
        y.truncate(32);
        Self::from_hex(&y).unwrap_or(Uuid::nil())
    }

    /// Create a uuid from a slice of length 16.
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_slice([47, 84, 63, 60, 6, 89, 78, 146, 51, 176, 200, 168, 92, 42, 200, 94]);
    ///
    /// assert_eq!(uuid.string(), "2f543f3c-0659-4e92-33b0-c8a85c2ac85e");
    /// ```
    pub fn from_slice(x: [u8; 16]) -> Self {
        Self(u128::from_be_bytes(x))
    }

    /// Create a uuid from any size vec of u8.
    ///
    /// ```
    /// use tycho::Uuid;
    /// let uuid = Uuid::from_bytes(&vec![47, 84, 63, 60, 6, 89, 78, 146, 51, 176, 200, 168, 92, 42, 200, 94]);
    ///
    /// assert_eq!(uuid.string(), "2f543f3c-0659-4e92-33b0-c8a85c2ac85e");
    /// ```
    pub fn from_bytes(x: &[u8]) -> Self {
        let mut bytes = [0u8; 16];
        bytes.copy_from_slice(&x);
        Self(u128::from_be_bytes(bytes))
    }
}

impl Default for Uuid {
    fn default() -> Self {
        Self::nil()
    }
}

impl fmt::Debug for Uuid {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("UUID(")?;
        f.write_str(&self.string())?;
        f.write_str(")")
    }
}
impl fmt::Display for Uuid {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.string())
    }
}

#[cfg(feature="serde")]
use serde::{Serialize, Serializer, Deserialize, Deserializer, de::Visitor, de::Error as DeError, ser::SerializeStruct};

#[cfg(feature="serde")]
impl Serialize for Uuid {
    fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
        S: Serializer {
        #[cfg(feature="serde_types")]
        return if serializer.is_human_readable() {
            serializer.serialize_str(&self.string())
        } else {
            let mut stu = serializer.serialize_struct("___tycho___/uuid", 1)?;
            stu.serialize_field("inner", &UuidBytes(self.slice()))?;
            stu.end()
        };

        #[cfg(not(feature="serde_types"))]
        return serializer.serialize_str(&self.string())
    }
}

#[cfg(feature="serde")]
pub struct UuidBytes([u8; 16]);

#[cfg(feature="serde")]
impl Serialize for UuidBytes {
    fn serialize<S>(&self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
        S: Serializer {
        serializer.serialize_bytes(&self.0)
    }
}

#[cfg(feature="serde")]
impl<'de> Deserialize<'de> for Uuid {
    fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error> where
        D: Deserializer<'de> {
        deserializer.deserialize_any(UuidVisitor)
    }
}

#[cfg(feature="serde")]
pub struct UuidVisitor;

#[cfg(feature="serde")]
impl<'de> Visitor<'de> for UuidVisitor {
    type Value = Uuid;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("valid UUID.")
    }

    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where
        E: DeError, {
        if let Some(value) = Uuid::from_string(&v) {
            Ok(value)
        } else {
            Err(E::custom("Invalid UUID"))
        }
    }

    fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E> where
        E: DeError, {
        Ok(Uuid::from_bytes(&v))
    }
}

impl From<uuid::Uuid> for Uuid {
    fn from(x: uuid::Uuid) -> Self {
        Self(x.as_u128())
    }
}

impl Into<uuid::Uuid> for Uuid {
    fn into(self) -> uuid::Uuid {
        uuid::Uuid::from_u128(self.0)
    }
}

use std::hash::{Hash, Hasher};

impl Hash for Uuid {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.0.hash(state)
    }
}