souvenir 0.3.1

Prefixed identifier library
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

use std::{
    fmt::{Debug, Display, Formatter},
    str::FromStr,
};

use crate::{encoding::parse_base32, Error, Id, Type};

impl Type for () {
    const PREFIX: &'static str = "";
}

#[derive(Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct Generic {
    prefix: String,
    value: Id<()>,
}

impl Generic {
    /// Create a new `Id<T>` with the following underlying value.
    pub fn new(prefix: impl Into<String>, value: [u8; 16]) -> Self {
        Self {
            prefix: prefix.into(),
            value: Id::new(value),
        }
    }

    /// Get the data value of the identifier.
    pub fn as_bytes(&self) -> &[u8; 16] {
        &self.value.as_bytes()
    }

    /// Get the data value of the identifier.
    pub fn to_bytes(self) -> [u8; 16] {
        self.value.to_bytes()
    }

    /// Get the data value of the identifier as a `u64`.
    pub fn to_u128(&self) -> u128 {
        self.value.to_u128()
    }

    /// Get the data value of the identifier as an `i64`.
    pub fn to_i128(&self) -> i128 {
        self.value.to_i128()
    }

    /// Test to see if the provided string is a valid `Generic`.
    pub fn test(value: &str) -> bool {
        Self::parse(value).is_ok()
    }

    /// Attempt to parse the provided string into a `Generic`.
    pub fn parse(value: &str) -> Result<Self, Error> {
        let (prefix, value) = value.split_once('_').ok_or(Error::InvalidData)?;

        Ok(Self {
            prefix: prefix.to_owned(),
            value: Id::new(parse_base32(value)?),
        })
    }

    /// Get the prefix of this identifier.
    pub fn prefix(&self) -> &str {
        &self.prefix
    }

    /// Cast this Id into an Id of a different type.
    pub const fn cast<U: Type + ?Sized>(&self) -> Id<U> {
        self.value.cast()
    }
}

impl Debug for Generic {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self)
    }
}

impl Display for Generic {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}{}", self.prefix, self.value)
    }
}

impl FromStr for Generic {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Self::parse(s)
    }
}

impl From<Generic> for u128 {
    fn from(value: Generic) -> Self {
        value.to_u128()
    }
}

impl From<Generic> for i128 {
    fn from(value: Generic) -> Self {
        value.to_i128()
    }
}

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

    #[test]
    fn generic_display() {
        let id = Generic::parse("test_7zzzzzzzzzzzzzzzzzzzzzzzzz").unwrap();
        assert_eq!(id.to_string(), "test_7zzzzzzzzzzzzzzzzzzzzzzzzz");
    }
}