spotproto 0.1.1

Wire protocol for the Spot real-time messaging network (packets, handshake, instant messages)
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

use std::fmt;

/// Errors returned by the protocol parser and serializers.
#[derive(Debug)]
pub enum Error {
    /// Attempted to parse an empty buffer.
    EmptyBuffer,
    /// The packet carries an unsupported protocol version (version, packet id).
    InvalidVersion(u8, u8),
    /// The packet type id is not known.
    UnknownPacket(u8),
    /// The buffer ended before the packet was fully decoded.
    Truncated,
    /// A name (sender/recipient) length exceeds the 256 byte limit.
    NameTooLong,
    /// CBOR encoding or decoding failed.
    Cbor(String),
    /// A cryptographic operation failed.
    Bottle(bottlers::BottleError),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::EmptyBuffer => write!(f, "empty buffer"),
            Error::InvalidVersion(v, p) => {
                write!(f, "invalid packet version {v} (packet {p})")
            }
            Error::UnknownPacket(p) => {
                write!(f, "failed to parse message: unknown packet id {p:x}")
            }
            Error::Truncated => write!(f, "truncated packet"),
            Error::NameTooLong => write!(f, "cannot read name from packet: too long"),
            Error::Cbor(e) => write!(f, "cbor error: {e}"),
            Error::Bottle(e) => write!(f, "bottle error: {e}"),
        }
    }
}

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

impl From<bottlers::BottleError> for Error {
    fn from(e: bottlers::BottleError) -> Self {
        Error::Bottle(e)
    }
}