bincode-next 3.0.0-rc.13

A compact, ultra-fast binary serialization format for Rust, optimized for networking and storage!
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

//! Static size trait for compile-time memory bound validation.

/// A trait that calculates the upper bound of a type's serialized size as a `const` value.
pub trait StaticSize {
    /// The maximum possible serialized size in bytes.
    const MAX_SIZE: usize;
}

// Primitives
impl StaticSize for bool {
    const MAX_SIZE: usize = 1;
}
impl StaticSize for u8 {
    const MAX_SIZE: usize = 1;
}
impl StaticSize for i8 {
    const MAX_SIZE: usize = 1;
}

impl StaticSize for u16 {
    const MAX_SIZE: usize = 3;
}
impl StaticSize for i16 {
    const MAX_SIZE: usize = 3;
}
impl StaticSize for u32 {
    const MAX_SIZE: usize = 5;
}
impl StaticSize for i32 {
    const MAX_SIZE: usize = 5;
}
impl StaticSize for u64 {
    const MAX_SIZE: usize = 9;
}
impl StaticSize for i64 {
    const MAX_SIZE: usize = 9;
}
impl StaticSize for u128 {
    const MAX_SIZE: usize = 17;
}
impl StaticSize for i128 {
    const MAX_SIZE: usize = 17;
}
impl StaticSize for usize {
    const MAX_SIZE: Self = 9;
}
impl StaticSize for isize {
    const MAX_SIZE: usize = 9;
}

impl StaticSize for f32 {
    const MAX_SIZE: usize = 4;
}
impl StaticSize for f64 {
    const MAX_SIZE: usize = 8;
}
impl StaticSize for char {
    const MAX_SIZE: usize = 4;
}
impl StaticSize for () {
    const MAX_SIZE: usize = 0;
}

impl<T> StaticSize for core::marker::PhantomData<T> {
    const MAX_SIZE: usize = 0;
}

// Arrays
impl<T: StaticSize, const N: usize> StaticSize for [T; N] {
    const MAX_SIZE: usize = T::MAX_SIZE * N;
}

// Option
impl<T: StaticSize> StaticSize for Option<T> {
    const MAX_SIZE: usize = 1 + T::MAX_SIZE;
}

// Result
impl<T: StaticSize, E: StaticSize> StaticSize for Result<T, E> {
    const MAX_SIZE: usize = 5
        + (if T::MAX_SIZE > E::MAX_SIZE {
            T::MAX_SIZE
        } else {
            E::MAX_SIZE
        });
}

// Tuples
macro_rules! impl_static_size_tuple {
    ($($name:ident),*) => {
        impl<$($name: StaticSize),*> StaticSize for ($($name,)*) {
            const MAX_SIZE: usize = 0 $(+ $name::MAX_SIZE)*;
        }
    }
}

impl_static_size_tuple!(A);
impl_static_size_tuple!(A, B);
impl_static_size_tuple!(A, B, C);
impl_static_size_tuple!(A, B, C, D);
impl_static_size_tuple!(A, B, C, D, E);
impl_static_size_tuple!(A, B, C, D, E, F);
impl_static_size_tuple!(A, B, C, D, E, F, G);
impl_static_size_tuple!(A, B, C, D, E, F, G, H);
impl_static_size_tuple!(A, B, C, D, E, F, G, H, I);
impl_static_size_tuple!(A, B, C, D, E, F, G, H, I, J);
impl_static_size_tuple!(A, B, C, D, E, F, G, H, I, J, K);
impl_static_size_tuple!(A, B, C, D, E, F, G, H, I, J, K, L);

/// Helper constants for common bincode structures
#[doc(hidden)]
pub mod helpers {
    /// The maximum bytes a `usize` (length) can take when encoded as a varint.
    pub const VARINT_MAX_64: usize = 9;
    /// The maximum bytes a `u32` can take when encoded as a varint.
    pub const VARINT_MAX_32: usize = 5;
}