sphinx_packet/
error.rs

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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// Copyright 2020 Nym Technologies SA
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::fmt::Formatter;
use std::{
    error::Error as StdError,
    fmt::{self, Display},
};

/// A `Result` alias where the `Err` case is `Sphinx::Error`.
pub type Result<T> = std::result::Result<T, Error>;

// type alias for local easy of use
// there's nothing fancy about it, we just ensure it implements std::error::Error and
// that it can be safely sent to another thread (`Send`) and shared between threads (`Sync`), i.e.
// &T is `Send`. In most cases those are usually true by default.
type StdThreadError = dyn StdError + Send + Sync;

/// Possible Sphinx errors, very strongly based on std::io::Error implementation
pub struct Error {
    repr: Repr,
}

// it has a StdError as long as it has Display and Debug
impl StdError for Error {}

#[derive(Debug)]
enum Repr {
    Simple(ErrorKind),
    Custom(Box<Custom>),
}

#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum ErrorKind {
    /// Error originating from packet related functionality.
    InvalidPacket,

    /// Error originating from general header related functionality.
    InvalidHeader,

    /// Error originating from payload related functionality.
    InvalidPayload,

    /// Error originating from SURB related functionality.
    InvalidSURB,

    /// Error originating routing information related functionality.
    InvalidRouting,
}

impl ErrorKind {
    pub(crate) fn as_str(&self) -> &'static str {
        match &self {
            ErrorKind::InvalidPacket => "packet processing failure",
            ErrorKind::InvalidHeader => "header processing failure",
            ErrorKind::InvalidPayload => "payload processing failure",
            ErrorKind::InvalidSURB => "SURB processing failure",
            ErrorKind::InvalidRouting => "routing information processing failure",
        }
    }
}

impl From<ErrorKind> for Error {
    fn from(kind: ErrorKind) -> Self {
        Error {
            repr: Repr::Simple(kind),
        }
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::result::Result<(), fmt::Error> {
        match self.repr {
            Repr::Simple(kind) => write!(f, "{}", kind.as_str()),
            Repr::Custom(ref c) => write!(f, "{}: {}", c.kind.as_str(), c.error),
        }
    }
}

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

#[derive(Debug)]
struct Custom {
    kind: ErrorKind,
    error: Box<StdThreadError>,
}

impl Error {
    pub fn new<E>(kind: ErrorKind, error: E) -> Self
    where
        E: Into<Box<StdThreadError>>,
    {
        Error {
            repr: Repr::Custom(Box::new(Custom {
                kind,
                error: error.into(),
            })),
        }
    }

    pub fn kind(&self) -> ErrorKind {
        match self.repr {
            Repr::Custom(ref c) => c.kind,
            Repr::Simple(kind) => kind,
        }
    }
}