databuf 0.5.0

This library used to serialize and deserialize structured data in binary format
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

use std::error::Error;
use std::fmt::{self, Display};

/// `enum` uses a discriminator to distinguish its variants.
///
/// This `UnknownDiscriminant` can happen when decoding an `enum` type that has an unknown discriminator value.
#[derive(Debug)]
pub struct UnknownDiscriminant<T> {
    /// Path of the `enum` struct
    pub ident: &'static str,
    /// Unrecognized discriminant value
    pub discriminant: T,
}

/// Occurs when there are not enough bytes in the input buffer to complete the decoding process.
#[derive(Debug)]
pub struct InsufficientBytes;

/// Occurs when invalid utf8 character found during the decoding process.
#[derive(Debug)]
pub struct InvalidChar;

/// Occurs when the integer value exceeds the maximum value that can be represented by the target integer type.
#[derive(Debug)]
pub struct IntegerOverflow;

/// Occurs during decoding when a [bool] value is expected, but the byte contains a value that is not `0` or `1`.
#[derive(Debug)]
pub struct InvalidBoolValue;

impl<T> Error for UnknownDiscriminant<T> where T: std::fmt::Debug + Display {}
impl Error for InsufficientBytes {}
impl Error for InvalidChar {}
impl Error for IntegerOverflow {}
impl Error for InvalidBoolValue {}

impl<D> UnknownDiscriminant<D>
where
    D: std::fmt::Debug + Display + Send + Sync + 'static,
{
    #[inline]
    #[doc(hidden)]
    pub fn new_boxed_err<T>(ident: &'static str, discriminant: D) -> crate::Result<T> {
        Err(Box::new(Self {
            ident,
            discriminant,
        }))
    }
}

impl<T: Display> Display for UnknownDiscriminant<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let Self {
            ident,
            discriminant,
        } = self;

        writeln!(f, "unknown `{discriminant}` discriminator of `{ident}`")
    }
}
impl Display for InsufficientBytes {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "insufficient bytes")
    }
}
impl Display for InvalidChar {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "invalid char")
    }
}
impl Display for IntegerOverflow {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "out of range integral type conversion attempted")
    }
}
impl Display for InvalidBoolValue {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "invalid value for bool type: expected 0 or 1")
    }
}