canary 0.3.3

provides ergonomic abstractions for network communication and more
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

use bincode::Options;
use serde::{de::DeserializeOwned, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};

use crate::err;

#[derive(Serialize_repr, Deserialize_repr, Clone, Copy)]
#[repr(u8)]
/// formats allowed for channels
pub enum Format {
    /// the Bincode serialization format
    Bincode = 1,
    #[cfg(feature = "json_ser")]
    /// the JSON serialization format
    Json = 2,
    #[cfg(feature = "bson_ser")]
    /// the BSON serialization format
    Bson = 3,
    #[cfg(feature = "postcard_ser")]
    /// the Postcard serialization format
    Postcard = 4,
    #[cfg(feature = "messagepack_ser")]
    /// the MessagePack serialization format
    MessagePack = 5,
}

impl Default for Format {
    fn default() -> Self {
        Format::Bincode
    }
}

impl SendFormat for Format {
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        match self {
            Format::Bincode => Bincode.serialize(obj),
            #[cfg(feature = "json_ser")]
            Format::Json => Json.serialize(obj),
            #[cfg(feature = "postcard_ser")]
            Format::Postcard => Postcard.serialize(obj),
            #[cfg(feature = "messagepack_ser")]
            Format::MessagePack => MessagePack.serialize(obj),
            #[cfg(feature = "bson_ser")]
            Format::Bson => Bson.serialize(obj),
        }
    }
}

impl ReadFormat for Format {
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: DeserializeOwned,
    {
        match self {
            Format::Bincode => Bincode.deserialize(bytes),
            #[cfg(feature = "json_ser")]
            Format::Json => Json.deserialize(bytes),
            #[cfg(feature = "postcard_ser")]
            Format::Postcard => Postcard.deserialize(bytes),
            #[cfg(feature = "messagepack_ser")]
            Format::MessagePack => MessagePack.deserialize(bytes),
            #[cfg(feature = "bson_ser")]
            Format::Bson => Bson.deserialize(bytes),
        }
    }
}

impl SendFormat for &mut Format {
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        match self {
            Format::Bincode => Bincode.serialize(obj),
            #[cfg(feature = "json_ser")]
            Format::Json => Json.serialize(obj),
            #[cfg(feature = "postcard_ser")]
            Format::Postcard => Postcard.serialize(obj),
            #[cfg(feature = "messagepack_ser")]
            Format::MessagePack => MessagePack.serialize(obj),
            #[cfg(feature = "bson_ser")]
            Format::Bson => Bson.serialize(obj),
        }
    }
}

impl ReadFormat for &mut Format {
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: DeserializeOwned,
    {
        match self {
            Format::Bincode => Bincode.deserialize(bytes),
            #[cfg(feature = "json_ser")]
            Format::Json => Json.deserialize(bytes),
            #[cfg(feature = "postcard_ser")]
            Format::Postcard => Postcard.deserialize(bytes),
            #[cfg(feature = "messagepack_ser")]
            Format::MessagePack => MessagePack.deserialize(bytes),
            #[cfg(feature = "bson_ser")]
            Format::Bson => Bson.deserialize(bytes),
        }
    }
}

/// bincode serialization format
pub struct Bincode;

#[cfg(feature = "json_ser")]
/// JSON serialization format
pub struct Json;
#[cfg(feature = "bson_ser")]
/// Postcard serialization format
pub struct Bson;

#[cfg(feature = "postcard_ser")]
/// Postcard serialization format
pub struct Postcard;

#[cfg(feature = "messagepack_ser")]
/// Postcard serialization format
pub struct MessagePack;

/// trait that represents the serialize side of a format
pub trait SendFormat {
    /// serialize object in this format
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>>;
}

/// trait that represents the deserialize side of a format
pub trait ReadFormat {
    /// deserialize object in this format
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned;
}

/// trait that represents a format that can serialize and deserialize
pub trait CompleteFormat: SendFormat + ReadFormat {}

impl SendFormat for Bincode {
    #[inline]
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        let obj = bincode::DefaultOptions::new()
            .allow_trailing_bytes()
            .serialize(obj)
            .map_err(err!(@invalid_data))?;
        Ok(obj.into())
    }
}
impl ReadFormat for Bincode {
    #[inline]
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned,
    {
        bincode::DefaultOptions::new()
            .allow_trailing_bytes()
            .deserialize(bytes)
            .map_err(err!(@invalid_data))
    }
}

#[cfg(feature = "json_ser")]
impl SendFormat for Json {
    #[inline]
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        serde_json::to_vec(obj).map_err(err!(@invalid_data))
    }
}

#[cfg(feature = "json_ser")]
impl ReadFormat for Json {
    #[inline]
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned,
    {
        serde_json::from_slice(bytes).map_err(err!(@invalid_data))
    }
}

#[cfg(feature = "bson_ser")]
impl SendFormat for Bson {
    #[inline]
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        bson::to_vec(obj).map_err(err!(@invalid_data))
    }
}

#[cfg(feature = "bson_ser")]
impl ReadFormat for Bson {
    #[inline]
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned,
    {
        bson::from_slice(bytes).map_err(err!(@invalid_data))
    }
}
#[cfg(feature = "postcard_ser")]
impl SendFormat for Postcard {
    #[inline]
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        postcard::to_allocvec(obj).map_err(err!(@invalid_data))
    }
}
#[cfg(feature = "postcard_ser")]
impl ReadFormat for Postcard {
    #[inline]
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned,
    {
        postcard::from_bytes(bytes).map_err(err!(@invalid_data))
    }
}

#[cfg(feature = "messagepack_ser")]
impl SendFormat for MessagePack {
    #[inline]
    fn serialize<O: Serialize>(&mut self, obj: &O) -> crate::Result<Vec<u8>> {
        rmp_serde::to_vec(obj).map_err(err!(@invalid_data))
    }
}
#[cfg(feature = "messagepack_ser")]
impl ReadFormat for MessagePack {
    #[inline]
    fn deserialize<T>(&mut self, bytes: &[u8]) -> crate::Result<T>
    where
        T: serde::de::DeserializeOwned,
    {
        rmp_serde::from_slice(bytes).map_err(err!(@invalid_data))
    }
}