hyprwire 0.3.0

A fast and consistent wire protocol for IPC
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

use hyprwire_core::message;
use std::{error, fmt, io};

/// Errors returned by the public Hyprwire client and server APIs.
#[derive(Debug)]
pub enum Error {
    /// The connection was closed by the peer or an unrecoverable protocol error
    /// occurred that has left the connection in an unusable state.
    ConnectionClosed,

    /// The initial handshake did not complete within the allowed timeout.
    HandshakeTimeout,

    /// Client and server could not agree on a compatible protocol version.
    VersionNegotiationFailed,

    /// The requested bind version exceeds the maximum version supported by the
    /// spec.
    VersionOutOfRange {
        /// The version that was requested.
        requested: u32,
        /// The highest version the spec supports.
        max: u32,
    },

    /// A wire-level protocol violation was detected.
    ProtocolViolation(message::Error),

    /// An OS-level I/O error.
    Io(io::Error),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ConnectionClosed => write!(f, "connection closed"),
            Self::HandshakeTimeout => write!(f, "handshake timed out"),
            Self::VersionNegotiationFailed => {
                write!(f, "version negotiation failed: no common protocol version")
            }
            Self::VersionOutOfRange { requested, max } => write!(
                f,
                "requested version {requested} exceeds spec maximum {max}"
            ),
            Self::ProtocolViolation(e) => write!(f, "protocol violation: {e}"),
            Self::Io(e) => write!(f, "I/O error: {e}"),
        }
    }
}

impl error::Error for Error {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Self::ProtocolViolation(e) => Some(e),
            Self::Io(e) => Some(e),
            _ => None,
        }
    }
}

impl From<message::Error> for Error {
    fn from(e: message::Error) -> Self {
        match e {
            message::Error::VersionNegotiationFailed => Self::VersionNegotiationFailed,
            other => Self::ProtocolViolation(other),
        }
    }
}