bserde 0.1.21

Library for serializing data to binary.
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

use std::error::Error;

pub mod serializer;
pub use serializer::types;

pub mod deserializer;

// SERIALIZER

/// # BSerialize
/// To begin serializing
pub trait BSerialize<'a> {
  fn serialize<S>(&'a self, serializer: &mut S) -> Result<(), S::Error>
  where
    S: BSerializer;
}


/// # BSerializer
/// Used for serializing fields of structs, enums, extendable
pub trait BSerializer: Sized {
  type Error: Error;

  type SerializeStruct<'a>: BSerializeStruct<Error = Self::Error>
  where
    Self: 'a;

  type SerializeEnum<'a>: BSerializeEnum<Error = Self::Error>
  where
    Self: 'a;

  fn new() -> Self;

  fn serialize_str(&mut self, value: &str) -> Result<(), Self::Error>;
  fn serialize_u8(&mut self, value: u8) -> Result<(), Self::Error>;
  fn serialize_u16(&mut self, value: u16) -> Result<(), Self::Error>;
  fn serialize_u32(&mut self, value: u32) -> Result<(), Self::Error>;
  fn serialize_u64(&mut self, value: u64) -> Result<(), Self::Error>;
  fn serialize_u128(&mut self, value: u128) -> Result<(), Self::Error>;

  fn serialize_i8(&mut self, value: i8) -> Result<(), Self::Error>;
  fn serialize_i16(&mut self, value: i16) -> Result<(), Self::Error>;
  fn serialize_i32(&mut self, value: i32) -> Result<(), Self::Error>;
  fn serialize_i64(&mut self, value: i64) -> Result<(), Self::Error>;
  fn serialize_i128(&mut self, value: i128) -> Result<(), Self::Error>;

  fn serialize_vec<'a, 'b, T>(&mut self, value: &'b Vec<T>) -> Result<(), Self::Error>
  where
    'b: 'a,
    T: BSerialize<'a>,
    &'a T: Into<&'a [u8]> + 'a;

  fn serialize_struct(
    &mut self,
    name: &'static str,
    len: usize,
  ) -> Result<Self::SerializeStruct<'_>, Self::Error>;

  fn serialize_enum(&mut self) -> Result<Self::SerializeEnum<'_>, Self::Error>;
}

/// # BSerializeStruct
/// Trait for serializing an struct
pub trait BSerializeStruct {
  type Error: Error;

  fn serialize_field<'a, T>(
    &mut self,
    key: impl Into<Option<&'static str>>,
    value: &'a T,
  ) -> Result<(), Self::Error>
  where
    T: ?Sized + BSerialize<'a>;

  fn end(self) -> Result<(), Self::Error>;
}

// # BSerializeEnum
/// Trait for serializing an enum
pub trait BSerializeEnum {
  type Error: Error;

  fn serialize_variant(&mut self, value: u16) -> Result<(), Self::Error>;
}

// DESERIALIZER

// # BSerializeEnum
/// Trait for deserializing
pub trait BDeserialize: Sized {
  type Error: Error;

  fn deserialize(input: &mut &[u8]) -> Result<Self, Self::Error>;
}