binsider 0.3.2

Analyze ELF binaries like a boss
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

use thiserror::Error as ThisError;

/// Custom error type.
#[derive(Debug, ThisError)]
pub enum Error {
    /// Error that may occur during I/O operations.
    #[error("IO error: `{0}`")]
    IoError(#[from] std::io::Error),
    /// Error that may occur during locating binaries.
    #[error("Unable to locate binary: `{0}`")]
    WhichError(#[from] which::Error),
    /// Error that may occur while receiving messages from the channel.
    #[error("Channel receive error: `{0}`")]
    ChannelReceiveError(#[from] std::sync::mpsc::RecvError),
    /// Error that may occur while sending messages to the channel.
    #[error("Channel send error: `{0}`")]
    ChannelSendError(String),
    /// Error that may occur while parsing ELF files.
    #[error("ELF parse error: `{0}`")]
    ElfError(#[from] elf::parse::ParseError),
    /// Error that may occur while extracting strings from binary data.
    #[error("String extraction error: `{0}`")]
    StringsError(String),
    /// Error that may occur while running hexdump.
    #[error("Hexdump (heh) error: `{0}`")]
    HexdumpError(String),
    /// Error that may occur while tracing system calls.
    #[error("Tracing system call error: `{0}`")]
    TraceError(String),
    /// Error that may occur while parsing integers.
    #[error("Failed to parse integer: `{0}`")]
    IntParseError(#[from] std::num::TryFromIntError),
    /// Error that may occur while analyzing library dependencies.
    #[error("Dependency analysis error: `{0}`")]
    LddError(#[from] lddtree::Error),
}

/// Type alias for the standard [`Result`] type.
pub type Result<T> = std::result::Result<T, Error>;

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;
    use std::io::Error as IoError;

    #[test]
    fn test_error() {
        let message = "your computer is on fire!";
        let error = Error::from(IoError::other(message));
        assert_eq!(format!("IO error: `{message}`"), error.to_string());
        assert_eq!(
            format!("\"IO error: `{message}`\""),
            format!("{:?}", error.to_string())
        );
    }
}