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
//! The Vino Codec crate contains the serialization and deserialization functions
//! and structures for communicating in and out of Vino Components.
//!
//! ### JSON
//!
//! Serializes to a [serde_json::Value] which can be printed as a JSON string.
//!
//! #### `json::serialize`
//!
//! ```
//! use vino_codec::{json, Error};
//! use serde::{Serialize, Deserialize};
//!
//! pub fn main() -> Result<(), Error> {
//!
//!   #[derive(Serialize, Deserialize)]
//!   struct Point {
//!     x: i32,
//!     y: i32,
//!   }
//!
//!   let point = Point { x: 200, y: 193 };
//!
//!   let value = json::serialize(&point)?;
//!   println!("{:?}", value);
//!
//!   assert_eq!(value, r#"{"x":200,"y":193}"#);
//!   Ok(())
//! }
//! ```
//!
//! #### `json::deserialize`
//!
//! ```
//! use vino_codec::{json, Error};
//! use serde::{Serialize, Deserialize};
//!
//! pub fn main() -> Result<(), Error> {
//!   #[derive(Serialize, Deserialize, Debug, PartialEq)]
//!   struct Point {
//!     x: i32,
//!     y: i32,
//!   }
//!
//!   let json = r#"{"x":200,"y":193}"#;
//!
//!   let instance: Point = json::deserialize(&json)?;
//!
//!   assert_eq!(instance, Point { x: 200, y: 193 });
//!   Ok(())
//! }
//!
//! ```
//!
//! ### MessagePack
//!
//! Serializes to a MessagePack [Vec<u8>].
//!
//! #### `messagepack::serialize`
//!
//! ```
//! use vino_codec::{messagepack, Error};
//! use serde::{Serialize, Deserialize};
//!
//! pub fn main() -> Result<(), Error> {
//!   #[derive(Serialize, Deserialize)]
//!   struct Point {
//!     x: i32,
//!     y: i32,
//!   }
//!
//!   let point = Point { x: 200, y: 193 };
//!
//!   let value = messagepack::serialize(&point)?;
//!   println!("{:?}", value);
//!
//!   let expected: Vec<u8> = vec![146, 204, 200, 204, 193];
//!   assert_eq!(value, expected);
//!   Ok(())
//! }
//! ```
//!
//! #### `messagepack::deserialize`
//!
//! ```
//! use vino_codec::{messagepack, Error};
//! use serde::{Serialize, Deserialize};
//!
//! pub fn main() -> Result<(), Error> {
//!   #[derive(Serialize, Deserialize, Debug, PartialEq)]
//!   struct Point {
//!     x: i32,
//!     y: i32,
//!   }
//!
//!   let slice = vec![146, 204, 200, 204, 193];
//!
//!   let instance: Point = messagepack::deserialize(&slice)?;
//!
//!   assert_eq!(instance, Point { x: 200, y: 193 });
//!   Ok(())
//! }
//! ```
//!
//! ### Raw
//!
//! The [raw] module uses [serde_value] as an intermediary format to pass around.
//!
//! ```
//! use vino_codec::{raw, Error};
//! use serde::{Serialize, Deserialize};
//!
//! pub fn main() -> Result<(), Error> {
//!   #[derive(Serialize, Deserialize, Debug, PartialEq)]
//!   struct Point {
//!     x: i32,
//!     y: i32,
//!   }
//!
//!   let point = Point { x: 200, y: 193 };
//!
//!   let value = raw::serialize(&point)?;
//!   let instance: Point = raw::deserialize(value)?;
//!
//!   assert_eq!(instance, Point { x: 200, y: 193 });
//!   Ok(())
//! }
//!```
//!

// !!START_LINTS
// Vino lints
// Do not change anything between the START_LINTS and END_LINTS line.
// This is automatically generated. Add exceptions after this section.
#![deny(
  clippy::expect_used,
  clippy::explicit_deref_methods,
  clippy::option_if_let_else,
  clippy::await_holding_lock,
  clippy::cloned_instead_of_copied,
  clippy::explicit_into_iter_loop,
  clippy::flat_map_option,
  clippy::fn_params_excessive_bools,
  clippy::implicit_clone,
  clippy::inefficient_to_string,
  clippy::large_types_passed_by_value,
  clippy::manual_ok_or,
  clippy::map_flatten,
  clippy::map_unwrap_or,
  clippy::must_use_candidate,
  clippy::needless_for_each,
  clippy::needless_pass_by_value,
  clippy::option_option,
  clippy::redundant_else,
  clippy::semicolon_if_nothing_returned,
  clippy::too_many_lines,
  clippy::trivially_copy_pass_by_ref,
  clippy::unnested_or_patterns,
  clippy::future_not_send,
  clippy::useless_let_if_seq,
  clippy::str_to_string,
  clippy::inherent_to_string,
  clippy::let_and_return,
  clippy::string_to_string,
  clippy::try_err,
  clippy::if_then_some_else_none,
  bad_style,
  clashing_extern_declarations,
  const_err,
  dead_code,
  deprecated,
  explicit_outlives_requirements,
  improper_ctypes,
  invalid_value,
  missing_copy_implementations,
  missing_debug_implementations,
  mutable_transmutes,
  no_mangle_generic_items,
  non_shorthand_field_patterns,
  overflowing_literals,
  path_statements,
  patterns_in_fns_without_body,
  private_in_public,
  trivial_bounds,
  trivial_casts,
  trivial_numeric_casts,
  type_alias_bounds,
  unconditional_recursion,
  unreachable_pub,
  unsafe_code,
  unstable_features,
  unused,
  unused_allocation,
  unused_comparisons,
  unused_import_braces,
  unused_parens,
  unused_qualifications,
  while_true,
  missing_docs
)]
// !!END_LINTS
// Add exceptions here
#![allow()]

/// The crate's error module.
pub mod error;

/// JSON serialization/deserialization.
#[cfg(feature = "json")]
pub mod json;

/// MessagePack serialization/deserialization.
#[cfg(feature = "messagepack")]
pub mod messagepack;

/// Serialization/deserialization implementations to raw [serde_value]s.
pub mod raw;

/// The crate's Result type.
pub(crate) type Result<T> = std::result::Result<T, error::CodecError>;

/// The crate's Error type.
pub type Error = error::CodecError;