bondrewd 0.1.14

Bit-Level field packing with proc_macros
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


//! Error types for Bondrewd Functionality which can fail. Base bondrewd with no
//! features other than derive will have no errors types.

#[cfg(not(feature = "std"))]
use core::fmt;
#[cfg(feature = "std")]
use std::fmt;

/// Error type describing that not enough bytes were provided in a slice.
#[derive(Debug)]
pub struct BitfieldSliceError(
    /// Amount of provided Bytes.
    pub usize,
    /// Amount of expected Bytes.
    pub usize
);

impl fmt::Display for BitfieldSliceError {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            fmt,
            "Expected {} bytes, {} bytes were provided.",
            self.1, self.0
        )
    }
}

#[cfg(feature = "std")]
impl std::error::Error for BitfieldSliceError {}

/// Error type describing that a character in provided slice is Invalid.
#[derive(Debug)]
pub struct BitfieldHexError(
    /// The Invalid character.
    pub char,
    /// The index of the Invalid character.
    pub usize
);

impl fmt::Display for BitfieldHexError {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            fmt,
            "Found Invalid character {} @ index {}.",
            self.0, self.1
        )
    }
}