peel 0.8.0

Dynamic packet parsing within trees
Documentation
//! Basic error handling mechanisms
use std::error::Error;
use std::{fmt, io};
use nom::Needed;

/// Representation for an error of the library
pub struct PeelError {
    /// The error variant
    pub code: ErrorType,

    /// Additional description for the error
    pub description: String,

    /// The cause for this error
    pub cause: Option<Box<Error>>,
}

impl PeelError {
    /// Create a new `PeelError`
    pub fn new(code: ErrorType, description: &str) -> Self {
        PeelError {
            code: code,
            description: description.to_string(),
            cause: None,
        }
    }
}


impl fmt::Display for PeelError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f,
               "Code: {:?}, Description: {}",
               self.code,
               self.description)
    }
}

impl fmt::Debug for PeelError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl Error for PeelError {
    fn description(&self) -> &str {
        &self.description
    }
}

// Error conversion
macro_rules! from_error {
    ($($p:ty,)*) => (
        $(impl From<$p> for PeelError {
            fn from(err: $p) -> PeelError {
                PeelError {
                    code: ErrorType::Other,
                    description: err.description().to_owned(),
                    cause: Some(Box::new(err)),
                }
            }
        })*
    )
}

from_error! {
    io::Error,
}

#[derive(Debug, Eq, PartialEq)]
/// Error codes as indicator what happened
pub enum ErrorType {
    /// New nodes have to be added before traversing
    NoTreeRoot,

    /// The first parser already failed
    NoParserSucceed,

    /// A parser got not enough data
    Incomplete(Needed),

    /// The error originates from another error
    Other,
}