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
use base64;
use derive_error::Error;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde_json;
#[derive(Debug, Error)]
pub enum MessageFormatError {
#[error(no_from, no_std)]
BinarySerializeError,
#[error(no_from, no_std)]
BinaryDeserializeError,
JSONError(serde_json::error::Error),
Base64DeserializeError(base64::DecodeError),
}
pub trait MessageFormat: Sized {
fn to_binary(&self) -> Result<Vec<u8>, MessageFormatError>;
fn to_json(&self) -> Result<String, MessageFormatError>;
fn to_base64(&self) -> Result<String, MessageFormatError>;
fn from_binary(msg: &[u8]) -> Result<Self, MessageFormatError>;
fn from_json(msg: &str) -> Result<Self, MessageFormatError>;
fn from_base64(msg: &str) -> Result<Self, MessageFormatError>;
}
impl<T> MessageFormat for T
where T: DeserializeOwned + Serialize
{
fn to_binary(&self) -> Result<Vec<u8>, MessageFormatError> {
bincode::serialize(self).map_err(|_| MessageFormatError::BinarySerializeError)
}
fn to_json(&self) -> Result<String, MessageFormatError> {
serde_json::to_string(self).map_err(MessageFormatError::JSONError)
}
fn to_base64(&self) -> Result<String, MessageFormatError> {
let val = self.to_binary()?;
Ok(base64::encode(&val))
}
fn from_binary(msg: &[u8]) -> Result<Self, MessageFormatError> {
bincode::deserialize(msg).map_err(|_| MessageFormatError::BinaryDeserializeError)
}
fn from_json(msg: &str) -> Result<Self, MessageFormatError> {
let mut de = serde_json::Deserializer::from_reader(msg.as_bytes());
Deserialize::deserialize(&mut de).map_err(MessageFormatError::JSONError)
}
fn from_base64(msg: &str) -> Result<Self, MessageFormatError> {
let buf = base64::decode(msg)?;
Self::from_binary(&buf)
}
}
#[cfg(test)]
mod test {
use super::*;
use base64::DecodeError as Base64Error;
use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
struct TestMessage {
key: String,
value: u64,
sub_message: Option<Box<TestMessage>>,
}
impl TestMessage {
pub fn new(key: &str, value: u64) -> TestMessage {
TestMessage {
key: key.to_string(),
value,
sub_message: None,
}
}
pub fn set_sub_message(&mut self, msg: TestMessage) {
self.sub_message = Some(Box::new(msg));
}
}
#[test]
fn binary_simple() {
let val = TestMessage::new("twenty", 20);
let msg = val.to_binary().unwrap();
assert_eq!(
msg,
b"\x06\x00\x00\x00\x00\x00\x00\x00\x74\x77\x65\x6e\x74\x79\x14\x00\x00\x00\x00\x00\x00\x00\x00"
);
let val2 = TestMessage::from_binary(&msg).unwrap();
assert_eq!(val, val2);
}
#[test]
fn base64_simple() {
let val = TestMessage::new("twenty", 20);
let msg = val.to_base64().unwrap();
assert_eq!(msg, "BgAAAAAAAAB0d2VudHkUAAAAAAAAAAA=");
let val2 = TestMessage::from_base64(&msg).unwrap();
assert_eq!(val, val2);
}
#[test]
fn json_simple() {
let val = TestMessage::new("twenty", 20);
let msg = val.to_json().unwrap();
assert_eq!(msg, "{\"key\":\"twenty\",\"value\":20,\"sub_message\":null}");
let val2 = TestMessage::from_json(&msg).unwrap();
assert_eq!(val, val2);
}
#[test]
fn nested_message() {
let inner = TestMessage::new("today", 100);
let mut val = TestMessage::new("tomorrow", 50);
val.set_sub_message(inner);
let msg_json = val.to_json().unwrap();
assert_eq!(
msg_json,
"{\"key\":\"tomorrow\",\"value\":50,\"sub_message\":{\"key\":\"today\",\"value\":100,\"sub_message\":\
null}}"
);
let msg_base64 = val.to_base64().unwrap();
assert_eq!(
msg_base64,
"CAAAAAAAAAB0b21vcnJvdzIAAAAAAAAAAQUAAAAAAAAAdG9kYXlkAAAAAAAAAAA="
);
let msg_bin = val.to_binary().unwrap();
assert_eq!(
msg_bin,
b"\x08\x00\x00\x00\x00\x00\x00\x00\x74\x6f\x6d\x6f\x72\x72\x6f\x77\x32\x00\x00\x00\x00\x00\x00\x00\x01\x05\x00\x00\x00\x00\x00\x00\x00\x74\x6f\x64\x61\x79\x64\x00\x00\x00\x00\x00\x00\x00\x00".to_vec()
);
let val2 = TestMessage::from_json(&msg_json).unwrap();
assert_eq!(val, val2);
let val2 = TestMessage::from_base64(&msg_base64).unwrap();
assert_eq!(val, val2);
let val2 = TestMessage::from_binary(&msg_bin).unwrap();
assert_eq!(val, val2);
}
#[test]
fn fail_json() {
let err = TestMessage::from_json("{\"key\":5}").err().unwrap();
match err {
MessageFormatError::JSONError(e) => {
assert_eq!(e.line(), 1);
assert_eq!(e.column(), 9);
assert!(e.is_data());
},
_ => panic!("JSON conversion should fail"),
};
}
#[test]
fn fail_base64() {
let err = TestMessage::from_base64("aaaaa$aaaaa").err().unwrap();
match err {
MessageFormatError::Base64DeserializeError(Base64Error::InvalidByte(offset, val)) => {
assert_eq!(offset, 5);
assert_eq!(val, b'$');
},
_ => panic!("Base64 conversion should fail"),
};
let err = TestMessage::from_base64("j6h0b21vcnJvdzKTpXRvZGF5ZMA=").err().unwrap();
match err {
MessageFormatError::BinaryDeserializeError => {},
_ => panic!("Base64 conversion should fail"),
};
}
#[test]
fn fail_binary() {
let err = TestMessage::from_binary(b"").err().unwrap();
match err {
MessageFormatError::BinaryDeserializeError => {},
_ => {
panic!("Base64 conversion should fail");
},
}
}
}