mbn 1.0.2

MBN format parse library
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

/// Re-export [`std::io::Error`].
pub use std::io::Error as IOError;

/// Re-export [`elf::ParseError`].
pub use elf::ParseError as ElfError;

/// The error type for parsing MBN format file.
#[derive(Debug)]
pub enum ParseError {
    /// Length of common metadata is not 24 bytes.
    CommonMetadataNotAligned(u32),
    /// Length of hash table is not a multiple of 32 or 48,
    /// or hash table does not contain at least 2 entries.
    HashTableNotAligned(u32),
    /// Input buffer length may be not long enough.
    InputUnexpectedTermination,
    /// File or byte stream format is invalid.
    InvalidFormat(ElfError),
    /// Input value is invalid.
    InvalidValue,
    /// I/O Error.
    IO(IOError),
    /// Length of metadata is not 120 or 224 bytes.
    MetadataNotAligned(u32),
    /// Cannot find hash table segment.
    NoHashTableSegment,
    /// MBN header version is not supported.
    UnsupportedHeaderVersion(u32),
}

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

impl From<elf::ParseError> for ParseError {
    fn from(value: elf::ParseError) -> Self {
        ParseError::InvalidFormat(value)
    }
}

impl std::fmt::Display for ParseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ParseError::CommonMetadataNotAligned(len) => {
                write!(f, "Length of common metadata '{}' is not 24 bytes", len)
            }
            ParseError::HashTableNotAligned(len) => {
                write!(
                    f,
                    "Length of hash table '{}' is not a multiple of 32 or 48, \
                        or hash table does not contain at least 2 entries.",
                    len
                )
            }
            ParseError::InputUnexpectedTermination => {
                write!(f, "Input buffer length may be not long enough")
            }
            ParseError::InvalidFormat(error) => write!(f, "{}", error),
            ParseError::InvalidValue => write!(f, "Input value is invalid"),
            ParseError::IO(error) => write!(f, "{}", error),
            ParseError::MetadataNotAligned(len) => {
                write!(f, "Length of metadata '{}' is not 120 or 224 bytes", len)
            }
            ParseError::NoHashTableSegment => write!(f, "Cannot find hash table segment"),
            ParseError::UnsupportedHeaderVersion(version) => {
                write!(f, "MBN header version '{}' is not supported", version)
            }
        }
    }
}

impl std::error::Error for ParseError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            ParseError::InvalidFormat(error) => Some(error),
            ParseError::IO(error) => Some(error),
            _ => None,
        }
    }
}