flatty-base 0.1.0-rc.4

Flatty traits and primitives
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

/// Flat type operation error.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Error {
    pub kind: ErrorKind,
    /// An offset from the beginning of flat type memory where error occur.
    pub pos: usize,
}

/// Error kinds that can occur while working with flat types.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum ErrorKind {
    /// The byte slice has insufficient size to be interpreted as required type.
    InsufficientSize,
    /// Memory isn't properly aligned to be interpreted as required type.
    BadAlign,
    /// Enum binary representation contains index that doesn't match any of possible enum states.
    InvalidEnumTag,
    /// Invalid binary representation of the type.
    InvalidData,
    /// Any other error.
    Other,
}

impl Error {
    /// Clone `self` and add `offset` to [`Self::pos`].
    pub fn offset(mut self, offset: usize) -> Self {
        self.pos += offset;
        self
    }
}