sbof 1.1.1

Small Binary Object 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

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

use serde::{de, ser};

pub type Result<T, E = Error> = std::result::Result<T, E>;

#[derive(Debug)]
pub enum Error {
    /// Custom error created by serde
    Custom(String),
    Io(std::io::Error),
    /// Produced when an unsupported function is called
    Unsupported {
        name: &'static str,
        reason: &'static str,
    },
    /// Produced when an unexpected EOF is found
    EOF,
    /// Produced when an invalid value is found
    InvalidValue {
        value: u32,
        reason: &'static str,
    },
    /// Produced when an unsupported version of SBOF is attempted to be deserialized
    UnsupportedVersion,
    /// Produced when an invalid UTF-8 string is found
    InvalidUTF8,
}

impl From<std::io::Error> for Error {
    fn from(value: std::io::Error) -> Self {
        Self::Io(value)
    }
}

impl ser::Error for Error {
    fn custom<T>(msg: T) -> Self
    where
        T: std::fmt::Display,
    {
        Self::Custom(msg.to_string())
    }
}

impl de::Error for Error {
    fn custom<T>(msg: T) -> Self
    where
        T: std::fmt::Display,
    {
        Self::Custom(msg.to_string())
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        use Error::*;

        match self {
            Custom(str) => write!(f, "{str}"),
            Unsupported { name, reason } => {
                write!(f, "unsupported function {name} called. {reason}")
            }
            Io(e) => write!(f, "{e}"),
            EOF => write!(f, "unexpected eof"),
            InvalidValue { value, reason } => write!(f, "invalid value {value}, {reason}"),
            UnsupportedVersion => write!(f, "tried to deserialize unsupported version of SBOF"),
            InvalidUTF8 => write!(f, "tried to parse invalid UTF-8"),
        }
    }
}

impl error::Error for Error {}