binary_codec/
lib.rs

1#[derive(Debug)]
2pub enum SerializationError {
3    /// Value is out of bounds (value, min, max)
4    ValueOutOfBounds(i32, i32, i32),
5
6    // Unexpected size (expected, actual)
7    UnexpectedLength(usize, usize),
8
9    /// Missing runtime length key
10    MissingLengthByKey(String),
11
12    /// Validation did fail for the data
13    InvalidData(String),
14}
15
16#[derive(Debug)]
17pub enum DeserializationError {
18    /// Not enough bytes (bytes missing)
19    NotEnoughBytes(usize),
20
21    // Unexpected size (expected, actual)
22    UnexpectedLength(usize, usize),
23
24    /// Unknown enum discriminator
25    UnknownDiscriminant(u8),
26
27    /// Missing runtime length key
28    MissingLengthByKey(String),
29
30    /// Validation did fail for the data
31    InvalidData(String),
32}
33
34pub trait BinarySerializer<T : Clone = ()> {
35    fn serialize(&self, config: Option<&mut SerializerConfig<T>>) -> Result<Vec<u8>, SerializationError>;
36    fn to_bytes(&self) -> Result<Vec<u8>, SerializationError> {
37        self.serialize(None)
38    }
39
40    fn write_bytes(&self, buffer: &mut Vec<u8>, config: Option<&mut SerializerConfig<T>>) -> Result<(), SerializationError>;
41}
42
43pub trait BinaryDeserializer<T : Clone = ()> : Sized {
44    fn deserialize(bytes: &[u8], config: Option<&mut SerializerConfig<T>>) -> Result<Self, DeserializationError>;
45    fn from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError> {
46        Self::deserialize(bytes, None)
47    }
48}
49
50mod config;
51pub mod utils;
52pub mod dynamics;
53pub mod fixed_int;
54pub mod dyn_int;
55pub mod variable;
56
57pub use binary_codec_derive::{ToBytes, FromBytes};
58pub use config::SerializerConfig;
binary_codec/lib.rs

binary_codec/
lib.rs
