Files
drop/libraries/native_model/src/codec/bincode_1_3.rs
T
2024-11-12 23:47:47 +01:00

53 lines
1.7 KiB
Rust

//! [bincode 1.3](https://crates.io/crates/bincode/1.3.3) ·
//! The default codec for serializing & deserializing.
/// Used to specify that the
/// [bincode 1.3](https://crates.io/crates/bincode/1.3.3) crate is to be used
/// for serialization & deserialization.
///
/// # Warning
///
/// `bincode` [does not implement](https://github.com/bincode-org/bincode/issues/548)
/// all [serde](https://crates.io/crates/serde) features. Errors may be
/// encountered when using this with some types.
///
/// If you are encountering errors when using this codec on your types, try
/// using the `rmp_serde_1_3` codec instead.
///
/// # Basic usage
///
/// Use the [`with`](crate::native_model) attribute on your type to instruct
/// `native_model` to use `Bincode` for serialization & deserialization.
///
/// Example usage:
///
/// ```rust
/// # use native_model::*;
/// #[derive(Clone, Default, serde::Deserialize, serde::Serialize)]
/// #[native_model(id = 1, version = 1, with = native_model::bincode_1_3::Bincode)]
/// struct MyStruct {
/// my_string: String
/// }
/// ```
#[derive(Default)]
pub struct Bincode;
#[cfg(all(feature = "serde", feature = "bincode_1_3"))]
impl<T: serde::Serialize> super::Encode<T> for Bincode {
type Error = bincode_1_3::Error;
/// Serializes a type into bytes using the `bincode` `1.3` crate.
fn encode(obj: &T) -> Result<Vec<u8>, Self::Error> {
bincode_1_3::serialize(obj)
}
}
#[cfg(all(feature = "serde", feature = "bincode_1_3"))]
impl<T: for<'de> serde::Deserialize<'de>> super::Decode<T> for Bincode {
type Error = bincode_1_3::Error;
/// Deserializes a type from bytes using the `bincode` `1.3` crate.
fn decode(data: Vec<u8>) -> Result<T, Self::Error> {
bincode_1_3::deserialize(&data[..])
}
}