bytey_bincode 0.1.1

Bytey Bincode Extension, use Bytey instead
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

use bincode::Decode;
use bytey_byte_buffer::{
    byte_buffer::ByteBuffer,
    error::{ByteBufferError, Result},
};

pub trait BincodeDecode {
    fn decode<T>(&mut self) -> Result<T>
    where
        T: Decode;
    fn decode_le<T>(&mut self) -> Result<T>
    where
        T: Decode;
    fn decode_be<T>(&mut self) -> Result<T>
    where
        T: Decode;
}

impl BincodeDecode for ByteBuffer {
    /// Reads a serialized value of type T that implements the [`bincode::Decode`] trait from the buffer.
    ///
    /// # Errors & Behaviour
    /// See [`read_slice`](Self::read_slice).
    /// See [`decode_from_slice`](bincode::decode_from_slice).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bincode::{self, Decode, Encode};
    /// use bytey_bincode::*;
    ///
    /// #[derive(PartialEq, Decode, Encode, Debug)]
    /// struct TestData {
    ///     x: u32,
    ///     y: u64,
    ///     i: f32,
    /// }
    ///
    /// let mut buffer = ByteBuffer::new().unwrap();
    /// let value = TestData {
    ///     x: 5,
    ///     y: 10,
    ///     i: 5.5,
    /// };
    ///
    /// buffer.encode(&value);
    /// buffer.move_cursor(0);
    ///
    /// println!("{:?}", buffer.decode::<TestData>().unwrap());
    /// buffer.move_cursor(0);
    ///
    /// let value: TestData = buffer.decode().unwrap();
    /// ```
    fn decode<T>(&mut self) -> Result<T>
    where
        T: Decode,
    {
        let size = self.read::<u64>()?;
        let source = ByteBuffer::read_slice(self, size as usize)?;

        let (decoded, _): (T, usize) =
            bincode::decode_from_slice(source, bincode::config::standard()).map_err(|e| {
                ByteBufferError::OtherError {
                    error: e.to_string(),
                }
            })?;

        Ok(decoded)
    }

    /// Reads a serialized value of type T that implements the [`bincode::Decode`] trait from the buffer in **little endian** ordering.
    ///
    /// # Errors & Behaviour
    /// See [`read_slice`](Self::read_slice).
    /// See [`decode_from_slice`](bincode::decode_from_slice).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bincode::{self, Decode, Encode};
    /// use bytey_bincode::*;
    ///
    /// #[derive(PartialEq, Decode, Encode, Debug)]
    /// struct TestData {
    ///     x: u32,
    ///     y: u64,
    ///     i: f32,
    /// }
    ///
    /// let mut buffer = ByteBuffer::new().unwrap();
    /// let value = TestData {
    ///     x: 5,
    ///     y: 10,
    ///     i: 5.5,
    /// };
    ///
    /// buffer.encode_le(&value);
    /// buffer.move_cursor(0);
    ///
    /// println!("{:?}", buffer.decode_le::<TestData>().unwrap());
    /// buffer.move_cursor(0);
    ///
    /// let value: TestData = buffer.decode_le().unwrap();
    /// ```
    fn decode_le<T>(&mut self) -> Result<T>
    where
        T: Decode,
    {
        let size = self.read_le::<u64>()?;
        let source = ByteBuffer::read_slice(self, size as usize)?;

        let (decoded, _): (T, usize) =
            bincode::decode_from_slice(source, bincode::config::standard().with_little_endian())
                .map_err(|e| ByteBufferError::OtherError {
                    error: e.to_string(),
                })?;

        Ok(decoded)
    }

    /// Reads a serialized value of type T that implements the [`bincode::Decode`] trait from the buffer in **big endian** ordering.
    ///
    /// # Errors & Behaviour
    /// See [`read_slice`](Self::read_slice).
    /// See [`decode_from_slice`](bincode::decode_from_slice).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bincode::{self, Decode, Encode};
    /// use bytey_bincode::*;
    ///
    /// #[derive(PartialEq, Decode, Encode, Debug)]
    /// struct TestData {
    ///     x: u32,
    ///     y: u64,
    ///     i: f32,
    /// }
    ///
    /// let mut buffer = ByteBuffer::new().unwrap();
    /// let value = TestData {
    ///     x: 5,
    ///     y: 10,
    ///     i: 5.5,
    /// };
    ///
    /// buffer.encode_be(&value);
    /// buffer.move_cursor(0);
    ///
    /// println!("{:?}", buffer.decode_be::<TestData>().unwrap());
    /// buffer.move_cursor(0);
    ///
    /// let value: TestData = buffer.decode_be().unwrap();
    /// ```
    fn decode_be<T>(&mut self) -> Result<T>
    where
        T: Decode,
    {
        let size = self.read_be::<u64>()?;
        let source = ByteBuffer::read_slice(self, size as usize)?;

        let (decoded, _): (T, usize) =
            bincode::decode_from_slice(source, bincode::config::standard().with_big_endian())
                .map_err(|e| ByteBufferError::OtherError {
                    error: e.to_string(),
                })?;

        Ok(decoded)
    }
}