bin-proto 0.12.7

Conversion to/from binary for arbitrary types
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

#[cfg(feature = "alloc")]
use alloc::boxed::Box;
use core::{convert::Infallible, fmt};
#[cfg(feature = "std")]
use std::io;

#[cfg(not(feature = "std"))]
use no_std_io2::io;

/// Alias for a Result with the error type [`Error`].
pub type Result<T> = core::result::Result<T, Error>;

#[derive(Debug)]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum Error {
    Io(io::Error),
    #[cfg(feature = "alloc")]
    FromUtf8(alloc::string::FromUtf8Error),
    #[cfg(feature = "alloc")]
    Nul(alloc::ffi::NulError),
    TryFromInt(core::num::TryFromIntError),
    Borrow(core::cell::BorrowError),
    Discriminant,
    TagConvert,
    #[cfg(feature = "std")]
    Poison,
    Underrun {
        read_bits: u64,
        available_bits: u64,
    },
    EncodeSkipped,
    Magic(&'static [u8]),
    #[cfg(feature = "alloc")]
    /// A catch-all for errors generated by user code
    Boxed(Box<dyn core::error::Error + Send + Sync>),
    /// A catch-all for error generated by user code, with a static message
    Other(&'static str),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Io(e) => write!(f, "{e}"),
            #[cfg(feature = "alloc")]
            Self::FromUtf8(e) => write!(f, "{e}"),
            #[cfg(feature = "alloc")]
            Self::Nul(e) => write!(f, "{e}"),
            Self::TryFromInt(e) => write!(f, "{e}"),
            Self::Borrow(e) => write!(f, "{e}"),
            Self::Discriminant => write!(f, "unknown enum discriminant"),
            Self::TagConvert => write!(f, "failed to convert tag"),
            #[cfg(feature = "std")]
            Self::Poison => write!(f, "poisoned lock"),
            Self::Magic(expected) => write!(f, "magic mismatch. Expected: {expected:?}."),
            Self::Underrun {
                read_bits: read,
                available_bits: available,
            } => {
                write!(f, "buffer underrun: read {read} of {available} bits")
            }
            Self::EncodeSkipped => write!(f, "attempted to encode skipped enum variant"),
            #[cfg(feature = "alloc")]
            Self::Boxed(e) => write!(f, "{e}"),
            Self::Other(e) => write!(f, "other: {e}"),
        }
    }
}

impl From<io::Error> for Error {
    #[inline]
    fn from(value: io::Error) -> Self {
        Self::Io(value)
    }
}

#[cfg(feature = "alloc")]
impl From<alloc::string::FromUtf8Error> for Error {
    #[inline]
    fn from(value: alloc::string::FromUtf8Error) -> Self {
        Self::FromUtf8(value)
    }
}

#[cfg(feature = "alloc")]
impl From<alloc::ffi::NulError> for Error {
    #[inline]
    fn from(value: alloc::ffi::NulError) -> Self {
        Self::Nul(value)
    }
}

impl From<core::num::TryFromIntError> for Error {
    #[inline]
    fn from(value: core::num::TryFromIntError) -> Self {
        Self::TryFromInt(value)
    }
}

impl From<core::cell::BorrowError> for Error {
    #[inline]
    fn from(value: core::cell::BorrowError) -> Self {
        Self::Borrow(value)
    }
}

impl From<Infallible> for Error {
    #[inline]
    fn from(_: Infallible) -> Self {
        unreachable!()
    }
}

#[cfg(feature = "std")]
impl<T> From<std::sync::PoisonError<T>> for Error {
    fn from(_: std::sync::PoisonError<T>) -> Self {
        Self::Poison
    }
}

impl core::error::Error for Error {}

#[cfg(test)]
mod tests {
    use super::*;

    #[allow(unused)]
    trait IsSizedSendSync: Sized + Send + Sync {}

    impl IsSizedSendSync for Error {}
}