ordpath 0.5.0

Implementation of the ORDPATH hierarchical labeling scheme
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

use std::error;
use std::fmt;
use std::io::Error as IoError;
use std::num::ParseIntError;

/// A list of possible types of errors that can cause parsing an ORDPATH to fail.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[non_exhaustive]
pub enum ErrorKind {
    /// Error due to the computed capacity exceeding the maximum length of [`OrdPath`].
    ///
    /// [`OrdPath`]: crate::OrdPath
    CapacityOverflow,
    /// A parameter was incorrect.
    InvalidInput,
}

impl ErrorKind {
    fn as_str(&self) -> &str {
        use ErrorKind::*;
        match *self {
            CapacityOverflow => "data capacity exceeds the ord path's maximum",
            InvalidInput => "invalid input",
        }
    }
}

impl fmt::Display for ErrorKind {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.write_str(self.as_str())
    }
}

/// The error type for operations on an ORDPATH.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Error {
    kind: ErrorKind,
}

impl Error {
    pub(crate) const fn new(kind: ErrorKind) -> Error {
        Error { kind }
    }

    /// Returns the corresponding [`ErrorKind`] for this error.
    pub const fn kind(&self) -> ErrorKind {
        self.kind
    }
}

impl fmt::Display for Error {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.kind.fmt(fmt)
    }
}

impl error::Error for Error {
    #[allow(deprecated, deprecated_in_future)]
    fn description(&self) -> &str {
        self.kind.as_str()
    }
}

impl From<ParseIntError> for Error {
    fn from(_: ParseIntError) -> Error {
        Error::new(ErrorKind::InvalidInput)
    }
}

impl From<IoError> for Error {
    fn from(_: IoError) -> Error {
        Error::new(ErrorKind::InvalidInput)
    }
}