btlightning 0.2.8

QUIC transport layer for Bittensor
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
75
76
77
78
79
80
81
82
83
84

use std::fmt;

/// Errors returned by Lightning operations.
#[derive(Debug)]
pub enum LightningError {
    /// QUIC connection establishment or reconnection failure.
    Connection(String),
    /// sr25519 handshake authentication failure between validator and miner.
    Handshake(String),
    /// Cryptographic signing operation failure.
    Signing(String),
    /// MessagePack serialization or deserialization failure.
    Serialization(String),
    /// QUIC stream-level I/O or framing error.
    Transport(String),
    /// Synapse handler returned an application-level error.
    Handler(String),
    /// Invalid configuration parameter.
    Config(String),
    /// Streaming response error (chunk read failure or server-side abort).
    Stream(String),
}

impl fmt::Display for LightningError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            LightningError::Connection(msg) => write!(f, "connection error: {}", msg),
            LightningError::Handshake(msg) => write!(f, "handshake error: {}", msg),
            LightningError::Signing(msg) => write!(f, "signing error: {}", msg),
            LightningError::Serialization(msg) => write!(f, "serialization error: {}", msg),
            LightningError::Transport(msg) => write!(f, "transport error: {}", msg),
            LightningError::Handler(msg) => write!(f, "handler error: {}", msg),
            LightningError::Config(msg) => write!(f, "config error: {}", msg),
            LightningError::Stream(msg) => write!(f, "stream error: {}", msg),
        }
    }
}

impl std::error::Error for LightningError {}

impl LightningError {
    /// Shorthand for `LightningError::Handler(e.to_string())`.
    pub fn handler(e: impl std::fmt::Display) -> Self {
        LightningError::Handler(e.to_string())
    }
}

/// Convenience alias for `std::result::Result<T, LightningError>`.
pub type Result<T> = std::result::Result<T, LightningError>;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display_formats_all_variants() {
        let cases: Vec<(LightningError, &str)> = vec![
            (
                LightningError::Connection("x".into()),
                "connection error: x",
            ),
            (LightningError::Handshake("x".into()), "handshake error: x"),
            (LightningError::Signing("x".into()), "signing error: x"),
            (
                LightningError::Serialization("x".into()),
                "serialization error: x",
            ),
            (LightningError::Transport("x".into()), "transport error: x"),
            (LightningError::Handler("x".into()), "handler error: x"),
            (LightningError::Config("x".into()), "config error: x"),
            (LightningError::Stream("x".into()), "stream error: x"),
        ];
        for (err, expected) in cases {
            assert_eq!(format!("{}", err), expected);
        }
    }

    #[test]
    fn handler_constructor() {
        let err = LightningError::handler("something failed");
        assert_eq!(format!("{}", err), "handler error: something failed");
        assert!(matches!(err, LightningError::Handler(_)));
    }
}