ratman 0.5.0

Ratman types, client, and interface library
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

// SPDX-FileCopyrightText: 2019-2023 Katharina Fey <kookie@spacekookie.de>
//
// SPDX-License-Identifier: AGPL-3.0-or-later WITH LicenseRef-AppStore

use crate::types::Address;
use async_std::io;

pub type Result<T> = std::result::Result<T, RatmanError>;

/// A central error facade for Ratman
///
/// Sub-scopes are handled via their own error types that are then
/// nested into this one.  Importantly, `Result` always refers to
/// `Result<T, RatmanError>` to keep the hand-up chain of errors
/// consistent.
///
/// When adding new category errors, make sure that the error message
/// follows the same consistent pattern of printing to "a {whatever}
/// error".  This allows for the error message to be chained in a
/// meaningful way.
// TODO(design): how to differentiate between errors that are fatal
// and those that are not?
#[derive(Debug, thiserror::Error)]
pub enum RatmanError {
    #[error("an i/o error: {0}")]
    Io(#[from] io::Error),
    #[cfg(feature = "proto")]
    #[error("a base encoding error: {0}")]
    Proto(#[from] protobuf::ProtobufError),
    #[error("a json encoding error: {0}")]
    Json(#[from] serde_json::error::Error),
    #[cfg(feature = "client")]
    #[error("a client API error: {0}")]
    ClientApi(#[from] crate::ClientError),
    #[cfg(feature = "netmod")]
    #[error("a netmod error: {0}")]
    Netmod(#[from] crate::NetmodError),
    // #[cfg(all(feature = "daemon", target_family = "unix"))]
    // #[error("a unix system error: {0}")]
    // UnixSystem(#[from] nix::errno::Errno),
    #[error("failed to acquire state directory lock")]
    StateDirectoryAlreadyLocked,
    #[error("failed to de-sequence a series of frames")]
    DesequenceFault,
    #[error("the given address '{0}' is unknown to this router!")]
    NoSuchAddress(Address),
    #[error("the address '{0}' already exists!")]
    DuplicateAddress(Address),
    #[error("the identifier data provided was not the correct length.  Expected {0}, got {1}")]
    WrongIdentifierLength(usize, usize),
}

impl From<RatmanError> for io::Error {
    fn from(e: RatmanError) -> Self {
        match e {
            RatmanError::Io(e) => e,
            e => panic!("unexpected IPC error: {}", e),
        }
    }
}

#[derive(Debug, thiserror::Error)]
pub enum NonfatalError {
    #[error("ratman is running ephemaral mode: no data will be persisted to disk!")]
    IsEphemeral,
}