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
// Refs are random, and so implementing Default doesn't really make sense.
#![allow(clippy::new_without_default)]

use std::fmt;
use std::num::NonZeroU128;
use std::str::FromStr;

/// An universally unique, optional reference to a Roblox instance.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Ref(Option<NonZeroU128>);

impl Ref {
    /// Generate a new random `Ref`.
    #[inline]
    pub fn new() -> Self {
        Ref(Some(rand::random()))
    }

    /// Generate a `Ref` that points to nothing.
    #[inline]
    pub fn none() -> Self {
        Ref(None)
    }

    /// Tells whether this `Ref` points to something.
    #[inline]
    pub fn is_some(&self) -> bool {
        self.0.is_some()
    }

    /// Tells whether this `Ref` points to nothing.
    #[inline]
    pub fn is_none(&self) -> bool {
        self.0.is_none()
    }

    fn value(&self) -> u128 {
        match self.0 {
            Some(value) => value.get(),
            None => 0,
        }
    }
}

impl fmt::Display for Ref {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        write!(formatter, "{:032x}", self.value())
    }
}

impl FromStr for Ref {
    type Err = std::num::ParseIntError;

    fn from_str(input: &str) -> Result<Self, Self::Err> {
        let value = u128::from_str_radix(input, 16)?;

        Ok(Ref(NonZeroU128::new(value)))
    }
}

#[cfg(feature = "serde")]
mod serde_impl {
    use super::*;

    use std::fmt;

    use serde::{
        de::{Error, Visitor},
        Deserialize, Deserializer, Serialize, Serializer,
    };

    impl Serialize for Ref {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: Serializer,
        {
            if serializer.is_human_readable() {
                serializer.serialize_str(&format!("{:032x}", self.value()))
            } else {
                serializer.serialize_u128(self.value())
            }
        }
    }

    struct RefVisitor;

    impl<'de> Visitor<'de> for RefVisitor {
        type Value = Ref;

        fn expecting(&self, out: &mut fmt::Formatter) -> fmt::Result {
            write!(out, "a Roblox referent")
        }

        fn visit_u128<E: Error>(self, value: u128) -> Result<Self::Value, E> {
            Ok(Ref(NonZeroU128::new(value)))
        }

        fn visit_str<E: Error>(self, ref_str: &str) -> Result<Self::Value, E> {
            let ref_value = u128::from_str_radix(ref_str, 16).map_err(E::custom)?;
            Ok(Ref(NonZeroU128::new(ref_value)))
        }
    }

    impl<'de> Deserialize<'de> for Ref {
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: Deserializer<'de>,
        {
            if deserializer.is_human_readable() {
                deserializer.deserialize_str(RefVisitor)
            } else {
                deserializer.deserialize_u128(RefVisitor)
            }
        }
    }
}

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

    #[test]
    fn display() {
        assert_eq!(Ref::none().to_string(), "00000000000000000000000000000000");

        let thirty = Ref(NonZeroU128::new(30));
        assert_eq!(thirty.to_string(), "0000000000000000000000000000001e");

        let max = Ref(NonZeroU128::new(u128::max_value()));
        assert_eq!(max.to_string(), "ffffffffffffffffffffffffffffffff");
    }

    #[test]
    fn from_str() {
        assert_eq!(
            Ref::from_str("00000000000000000000000000000000").unwrap(),
            Ref::none()
        );

        assert_eq!(
            Ref::from_str("00000000300000e00f00000000000001").unwrap(),
            Ref(NonZeroU128::new(14855284604576099720297971713))
        );

        assert_eq!(
            Ref::from_str("ffffffffffffffffffffffffffffffff").unwrap(),
            Ref(NonZeroU128::new(u128::max_value()))
        );
    }

    #[test]
    fn size() {
        assert_eq!(std::mem::size_of::<Ref>(), std::mem::size_of::<u128>());
    }
}

#[cfg(all(test, feature = "serde"))]
mod serde_test {
    use super::*;

    #[test]
    fn human_none() {
        let value = Ref::none();

        let ser = serde_json::to_string(&value).unwrap();
        assert_eq!(ser, "\"00000000000000000000000000000000\"");

        let de: Ref = serde_json::from_str(&ser).unwrap();

        assert_eq!(value, de);
    }

    #[test]
    fn human() {
        let value = Ref::new();

        let ser = serde_json::to_string(&value).unwrap();
        let de = serde_json::from_str(&ser).unwrap();

        assert_eq!(value, de);
    }

    #[test]
    fn non_human() {
        let value = Ref::new();

        let ser = bincode::serialize(&value).unwrap();
        let de = bincode::deserialize(&ser).unwrap();

        assert_eq!(value, de);
    }
}