links-notation 0.23.0

Rust implementation of the Links Notation parser
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

//! Errors from binary links notation codecs.

use std::{error::Error, fmt, io};

/// A failure while encoding or decoding a packet or LiNo document.
#[derive(Debug)]
pub enum BinaryError {
    Io(io::Error),
    Malformed(String),
    InvalidLino(String),
    LimitExceeded(String),
    Unencodable(String),
}

impl BinaryError {
    pub(crate) fn malformed(message: impl Into<String>) -> Self {
        Self::Malformed(message.into())
    }
}

impl fmt::Display for BinaryError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let (kind, detail) = match self {
            Self::Io(error) => return write!(f, "I/O error: {error}"),
            Self::Malformed(detail) => ("malformed message", detail),
            Self::InvalidLino(detail) => ("invalid LiNo", detail),
            Self::LimitExceeded(detail) => ("limit exceeded", detail),
            Self::Unencodable(detail) => ("cannot encode", detail),
        };
        write!(f, "{kind}: {detail}")
    }
}

impl Error for BinaryError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::Io(error) => Some(error),
            _ => None,
        }
    }
}

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

/// Result returned by the binary codecs.
pub type BinaryResult<T> = Result<T, BinaryError>;