serialization 0.2.12

encode and decode your struct
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
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

use std::mem::{ManuallyDrop, MaybeUninit};

use concat_idents_bruce0203::concat_idents;

#[cfg_attr(feature = "fast_binary_format", const_trait)]
pub trait CheckPrimitiveTypeSize {
    fn is_sized<T: 'static>() -> bool {
        false
    }
}

pub trait BinaryEncoder {
    fn skip_bytes(&mut self, len: usize);
    fn write_bytes(&mut self, data: &[u8]) -> Result<(), ()>;
}

pub trait BinaryDecoder {
    fn skip_bytes(&mut self, len: usize);
    fn read_bytes(&mut self, len: usize) -> Result<&[u8], ()>;
}

pub trait Encode {
    fn encode<E: Encoder>(&self, encoder: &mut E) -> Result<(), E::Error>;
}

pub trait Decode: Sized {
    fn decode<D: Decoder>(decoder: &mut D, place: &mut MaybeUninit<Self>) -> Result<(), D::Error>;

    fn decode_placed<D: Decoder>(decoder: &mut D) -> Result<Self, D::Error> {
        let mut place: MaybeUninit<Self> = unsafe { MaybeUninit::uninit().assume_init() };
        Self::decode(decoder, &mut place)?;
        Ok(unsafe { place.assume_init() })
    }
}

pub trait CompositeEncoder: BinaryEncoder {
    type Error;
    fn encode_element<E: Encode>(&mut self, v: &E) -> Result<(), Self::Error>;
    fn end(&mut self) -> Result<(), Self::Error>;
}

macro_rules! encode_value {
    ($($type:ty),*) => {$(
        concat_idents!(fn_name = encode_, $type, {
            fn fn_name(&mut self, v: $type) -> Result<(), Self::Error>;
        });
    )*};
}

macro_rules! decode_value {
    ($($type:ty),*) => {$(
        concat_idents!(fn_name = decode_, $type, {
            fn fn_name(&mut self, place: &mut MaybeUninit<$type>) -> Result<(), Self::Error>;
        });
    )*};
}

macro_rules! declare_encoder_supertrait {
    ($($value:ident),*) => {
        #[cfg_attr(feature = "fast_binary_format", const_trait)]
        pub trait Encoder: Sized + BinaryEncoder $(+ const $value)* {
            type Error: EncodeError;
            type TupleEncoder: CompositeEncoder<Error = Self::Error>;
            type StructEncoder: CompositeEncoder<Error = Self::Error>;
            type SequenceEncoder: CompositeEncoder<Error = Self::Error>;

            encode_value!(
                bool, u8, i8, u16, i16, u32, i32, u64, i64, u128, i128, usize, isize, f32, f64
            );

            fn encode_tuple(&mut self) -> Result<&mut Self::TupleEncoder, Self::Error>;
            fn encode_struct(&mut self) -> Result<&mut Self::StructEncoder, Self::Error>;
            fn encode_seq(&mut self, len: usize) -> Result<&mut Self::SequenceEncoder, Self::Error>;

            fn encode_enum_variant_key(
                &mut self,
                enum_name: &'static str,
                variant_name: &'static str,
                variant_index: usize,
            ) -> Result<(), Self::Error>;

            fn encode_some(&mut self) -> Result<(), Self::Error>;
            fn encode_none(&mut self) -> Result<(), Self::Error>;

            fn encode_str(&mut self, v: &str) -> Result<(), Self::Error>;
            fn encode_bytes(&mut self, v: &[u8]) -> Result<(), Self::Error>;
            fn encode_var_i32(&mut self, v: i32) -> Result<(), Self::Error>;
        }
    };
}
#[cfg(feature = "fast_binary_format")]
declare_encoder_supertrait!(CheckPrimitiveTypeSize);
#[cfg(not(feature = "fast_binary_format"))]
declare_encoder_supertrait!();

pub trait CompositeDecoder: BinaryDecoder + Sized {
    type Error;
    fn decode_element<D: Decode>(&mut self, place: &mut MaybeUninit<D>) -> Result<(), Self::Error>;
    fn end(&mut self) -> Result<(), Self::Error>;
}

pub enum EnumIdentifier {
    Name(&'static str),
    Index(usize),
}

pub trait EncodeError {
    fn not_enough_bytes_in_the_buffer() -> Self;
    fn too_large() -> Self;
    fn custom() -> Self;
}

pub trait DecodeError {
    fn not_enough_bytes_in_the_buffer() -> Self;
    fn too_large() -> Self;
    fn invalid_enum_variant_name() -> Self;
    fn invalid_enum_variant_index() -> Self;
    fn custom() -> Self;
    fn invalid_utf8() -> Self;
    fn nonmax_but_max() -> Self;
    fn nonzero_but_zero() -> Self;
}

macro_rules! declare_decoder_supertrait {
    ($($value:ident),*) => {
        #[cfg_attr(feature = "fast_binary_format", const_trait)]
        pub trait Decoder: Sized + BinaryDecoder $(+ const $value)* {
            type Error: DecodeError;
            type TupleDecoder: CompositeDecoder< Error = Self::Error>;
            type StructDecoder: CompositeDecoder< Error = Self::Error>;
            type SequenceDecoder: CompositeDecoder< Error = Self::Error>;

            decode_value!(bool, u8, i8, u16, i16, u32, i32, u64, i64, u128, i128, usize, isize, f32, f64);

            fn decode_str(&mut self, place: &mut MaybeUninit<& str>) -> Result<(), Self::Error>;
            fn decode_bytes(&mut self) -> Result<&[u8], Self::Error>;
            fn decode_var_i32(&mut self, place: &mut MaybeUninit<i32>) -> Result<(), Self::Error>;

            fn decode_tuple(&mut self) -> Result<&mut Self::TupleDecoder, Self::Error>;
            fn decode_struct(&mut self) -> Result<&mut Self::StructDecoder, Self::Error>;
            fn decode_seq(&mut self) -> Result<&mut Self::SequenceDecoder, Self::Error>;

            fn decode_seq_len(&mut self) -> Result<usize, Self::Error>;
            fn decode_enum(&mut self, enum_name: &'static str) -> Result<EnumIdentifier, Self::Error>;

            fn decode_is_some(&mut self) -> Result<bool, Self::Error>;
        }
    }
}

#[cfg(feature = "fast_binary_format")]
declare_decoder_supertrait!(CheckPrimitiveTypeSize);
#[cfg(not(feature = "fast_binary_format"))]
declare_decoder_supertrait!();