relox 0.1.0

ELF32 relocation compression and decompression
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

/// Possible reasons of an [Error](#Error).
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ErrorKind {
    /// The data provided is invalid.
    InvalidData,
    /// There is not enough data to perform the requested operation.
    NotEnoughData,
    /// Buffer is too small.
    BufferSmall,
}

/// Representation of an error.
#[derive(Debug)]
pub struct Error {
    /// Kind of the error.
    reason: ErrorKind,
}

impl Error {
    /// Creates a new `Error` instance.
    pub fn new(reason: ErrorKind) -> Self {
        Self { reason: reason }
    }

    /// Returns the reason of this error.
    pub fn kind(&self) -> ErrorKind {
        self.reason
    }
}

impl PartialEq for Error {
    fn eq(&self, other: &Self) -> bool {
        self.kind() == other.kind()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new() {
        Error::new(ErrorKind::InvalidData);
    }

    #[test]
    fn test_kind() {
        let err = Error::new(ErrorKind::InvalidData);
        assert_eq!(err.kind(), ErrorKind::InvalidData);
        assert_ne!(err.kind(), ErrorKind::NotEnoughData);
    }

    #[test]
    fn test_partialeq() {
        let err1 = Error::new(ErrorKind::InvalidData);
        let err2 = Error::new(ErrorKind::NotEnoughData);
        let err3 = Error::new(ErrorKind::NotEnoughData);
        assert_ne!(err1, err2);
        assert_eq!(err2, err3);
    }

    #[cfg(not(feature = "no_std"))]
    #[test]
    fn test_std_fmt_debug() {
        println!("{:?}", Error::new(ErrorKind::InvalidData));
    }

    #[test]
    fn test_std_clone_clone() {
        Error::new(ErrorKind::InvalidData.clone());
    }
}