encode 1.0.0

A simple framework for encoding binary data.
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

use arrayvec::ArrayString;
use arrayvec::ArrayVec;

use super::InsufficientSpace;
use crate::BaseEncoder;
use crate::ByteEncoder;
use crate::StrEncoder;

impl<const SIZE: usize> BaseEncoder for ArrayVec<u8, SIZE> {
    type Error = InsufficientSpace;
}

impl<const SIZE: usize> ByteEncoder for ArrayVec<u8, SIZE> {
    #[inline]
    fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error> {
        self.try_extend_from_slice(slice)
            .map_err(|_| InsufficientSpace)
    }

    #[inline]
    fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error> {
        self.try_push(byte).map_err(|_| InsufficientSpace)
    }
}

impl<const SIZE: usize> BaseEncoder for ArrayString<SIZE> {
    type Error = InsufficientSpace;
}

impl<const SIZE: usize> StrEncoder for ArrayString<SIZE> {
    #[inline]
    fn put_str(&mut self, string: &str) -> Result<(), Self::Error> {
        self.try_push_str(string).map_err(|_| InsufficientSpace)
    }
}

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

    #[test]
    fn assert_that_encoding_something_into_an_empty_arrayvec_always_fails() {
        let mut encoder = ArrayVec::<u8, 0>::new();
        let encodable = "hello";
        assert!(
            encodable.encode(&mut encoder).is_err(),
            "Empty arrays should always fail"
        );
    }

    #[test]
    fn assert_that_arrayvecs_can_be_used_as_encoders() {
        let mut buf = ArrayVec::<u8, 64>::new();
        let encodable = ("hello", 0u8);

        encodable.encode(&mut buf).unwrap();

        assert_eq!(buf.len(), 6, "The buffer should contain 5 bytes");
        assert_eq!(
            buf.as_slice(),
            b"hello\0",
            "The buffer should contain the encoded string"
        );
    }

    #[test]
    fn assert_that_arraystrings_can_be_used_as_str_encoders() {
        let mut buf = ArrayString::<64>::new();
        let encodable = "hello";

        encodable.encode(&mut buf).unwrap();

        assert_eq!(buf.len(), 5, "The buffer should contain 5 bytes");
        assert_eq!(
            buf.as_str(),
            "hello",
            "The buffer should contain the encoded string"
        );
    }
}