bytekind 0.2.0

Containers for byte arrays that are generic over their 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

use core::fmt::{Debug, Formatter};
use core::hash::Hash;
use core::marker::PhantomData;

use crate::Format;

#[cfg(feature = "proptest")]
mod proptest;
mod serde;

/// A wrapper around `[u8; N]` that allows control over the serialization format
#[derive(Copy)]
pub struct ByteArray<F: Format, const N: usize> {
    inner: [u8; N],
    _marker: PhantomData<F>,
}

impl<F: Format, const N: usize> Debug for ByteArray<F, N> {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("ByteArray")
            .field("inner", &self.inner)
            .finish_non_exhaustive()
    }
}
impl<F: Format, const N: usize> Clone for ByteArray<F, N> {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner,
            _marker: PhantomData,
        }
    }
}

impl<F: Format, G: Format, const N: usize> PartialEq<ByteArray<F, N>> for ByteArray<G, N> {
    fn eq(&self, other: &ByteArray<F, N>) -> bool {
        self.inner.eq(&other.inner)
    }
}

impl<F: Format, const N: usize> Eq for ByteArray<F, N> {}

impl<F: Format, const N: usize> PartialEq<&[u8; N]> for ByteArray<F, N> {
    fn eq(&self, other: &&[u8; N]) -> bool {
        self.inner.eq(*other)
    }
}

impl<F: Format, const N: usize> PartialEq<[u8; N]> for ByteArray<F, N> {
    fn eq(&self, other: &[u8; N]) -> bool {
        self.inner.eq(other)
    }
}

impl<F: Format, const N: usize> PartialEq<&[u8]> for ByteArray<F, N> {
    fn eq(&self, other: &&[u8]) -> bool {
        self.inner.eq(other)
    }
}

impl<F: Format, const N: usize> PartialEq<[u8]> for ByteArray<F, N> {
    fn eq(&self, other: &[u8]) -> bool {
        self.inner.eq(other)
    }
}

impl<F: Format, const N: usize> PartialOrd for ByteArray<F, N> {
    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
        <[u8; N]>::partial_cmp(&self.inner, &other.inner)
    }
}

impl<F: Format, const N: usize> Ord for ByteArray<F, N> {
    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
        <[u8; N]>::cmp(&self.inner, &other.inner)
    }
}

impl<F: Format, const N: usize> From<[u8; N]> for ByteArray<F, N> {
    fn from(inner: [u8; N]) -> Self {
        Self {
            inner,
            _marker: PhantomData,
        }
    }
}

impl<F: Format, const N: usize> From<ByteArray<F, N>> for [u8; N] {
    fn from(array: ByteArray<F, N>) -> Self {
        array.inner
    }
}

impl<F: Format, const N: usize> Hash for ByteArray<F, N> {
    fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
        <[u8; N]>::hash(&self.inner, state);
    }
}

impl<F: Format, const N: usize> ByteArray<F, N> {
    /// Consume `self` and return the underlying `[u8; N]`
    #[inline]
    pub fn into_inner(self) -> [u8; N] {
        self.inner
    }
}

impl<F: Format, const N: usize> AsRef<[u8]> for ByteArray<F, N> {
    fn as_ref(&self) -> &[u8] {
        &self.inner
    }
}

impl<F: Format, const N: usize> AsMut<[u8]> for ByteArray<F, N> {
    fn as_mut(&mut self) -> &mut [u8] {
        &mut self.inner
    }
}

impl<F: Format, const N: usize> AsRef<[u8; N]> for ByteArray<F, N> {
    fn as_ref(&self) -> &[u8; N] {
        &self.inner
    }
}

impl<F: Format, const N: usize> AsMut<[u8; N]> for ByteArray<F, N> {
    fn as_mut(&mut self) -> &mut [u8; N] {
        &mut self.inner
    }
}

#[cfg(test)]
mod tests {
    use serde_json::{from_value, json};

    use crate::{HexString, Plain};

    use super::*;

    #[test]
    fn check_eq_impls() {
        let byte_array: ByteArray<Plain, 4> = ByteArray::from([0, 1, 2, 3]);

        let first = byte_array == [0, 1, 2, 3];
        assert!(first);

        let slice: &[u8] = &[0, 1, 2, 3];
        let second = byte_array == slice;
        assert!(second);

        let array_ref: &[u8; 4] = &[0, 1, 2, 3];
        let third = byte_array == array_ref;
        assert!(third);

        let fourth = byte_array == byte_array;
        assert!(fourth);
    }

    #[test]
    fn parses_with_leading_0x() {
        let byte_array: ByteArray<HexString, 1> = from_value(json!("0x00")).unwrap();
        assert_eq!(byte_array, [0]);
    }
}