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

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

pub trait BincodeEncode {
    fn encode<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode;
    fn encode_le<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode;
    fn encode_be<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode;
}

impl BincodeEncode for ByteBuffer {
    /// Serializes and Writes the given value to the [`ByteBuffer`].
    ///
    /// The value has to implement the [`bincode::Encode`] trait.
    ///
    /// # Errors & Behaviour
    /// See [`write_slice`](Self::write_slice).
    /// See [`encode_to_vec`](bincode::encode_to_vec).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bytey_bincode::*;
    /// use bincode::{self, Encode};
    ///
    /// #[derive(PartialEq, 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);
    /// ```
    fn encode<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode,
    {
        let bytes = bincode::encode_to_vec(&source, bincode::config::standard()).map_err(|e| {
            ByteBufferError::OtherError {
                error: e.to_string(),
            }
        })?;

        self.write(bytes.len() as u64)?;
        self.write_slice(&bytes[..])
    }

    /// Serializes and Writes the given value to the [`ByteBuffer`] in **little endian** ordering.
    ///
    /// The value has to implement the [`bincode::Encode`] trait.
    ///
    /// # Errors & Behaviour
    /// See [`write_slice`](Self::write_slice).
    /// See [`encode_to_vec`](bincode::encode_to_vec).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bytey_bincode::*;
    /// use bincode::{self, Encode};
    ///
    /// #[derive(PartialEq, 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);
    /// ```
    fn encode_le<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode,
    {
        let bytes =
            bincode::encode_to_vec(&source, bincode::config::standard().with_little_endian())
                .map_err(|e| ByteBufferError::OtherError {
                    error: e.to_string(),
                })?;

        self.write_le(bytes.len() as u64)?;
        self.write_slice(&bytes[..])
    }

    /// Serializes and Writes the given value to the [`ByteBuffer`] in **big endian** ordering.
    ///
    /// The value has to implement the [`bincode::Encode`] trait.
    ///
    /// # Errors & Behaviour
    /// See [`write_slice`](Self::write_slice).
    /// See [`encode_to_vec`](bincode::encode_to_vec).
    ///
    /// # Examples
    /// ```
    /// use bytey_byte_buffer::byte_buffer::ByteBuffer;
    /// use bytey_bincode::*;
    /// use bincode::{self, Encode};
    ///
    /// #[derive(PartialEq, 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);
    /// ```
    fn encode_be<T>(&mut self, source: T) -> Result<&mut Self>
    where
        T: Encode,
    {
        let bytes = bincode::encode_to_vec(&source, bincode::config::standard().with_big_endian())
            .map_err(|e| ByteBufferError::OtherError {
                error: e.to_string(),
            })?;

        self.write_be(bytes.len() as u64)?;
        self.write_slice(&bytes[..])
    }
}