veloren/network/protocol/src/error.rs

/// All possible Errors that can happen during Handshake [`InitProtocol`]
///
/// [`InitProtocol`]: crate::InitProtocol
#[derive(Debug, PartialEq)]
pub enum InitProtocolError {
    Closed,
    WrongMagicNumber([u8; 7]),
    WrongVersion([u32; 3]),
}

/// When you return closed you must stay closed!
#[derive(Debug, PartialEq)]
pub enum ProtocolError {
    /// Closed indicates the underlying I/O got closed
    /// e.g. the TCP, UDP or MPSC connection is dropped by the OS
    Closed,
    /// Violated indicates the veloren_network_protocol was violated
    /// the underlying I/O connection is still valid, but the remote side
    /// send WRONG (e.g. Invalid, or wrong order) data on the protocol layer.
    Violated,
}

impl From<ProtocolError> for InitProtocolError {
    fn from(err: ProtocolError) -> Self {
        match err {
            ProtocolError::Closed => InitProtocolError::Closed,
            // not possible as the Init has raw access to the I/O
            ProtocolError::Violated => InitProtocolError::Closed,
        }
    }
}

impl core::fmt::Display for InitProtocolError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            InitProtocolError::Closed => write!(f, "Channel closed"),
            InitProtocolError::WrongMagicNumber(r) => write!(
                f,
                "Magic Number doesn't match, remote side send '{:?}' instead of '{:?}'",
                &r,
                &crate::types::VELOREN_MAGIC_NUMBER
            ),
            InitProtocolError::WrongVersion(r) => write!(
                f,
                "Network doesn't match, remote side send '{:?}' we are on '{:?}'",
                &r,
                &crate::types::VELOREN_NETWORK_VERSION
            ),
        }
    }
}

impl core::fmt::Display for ProtocolError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            ProtocolError::Closed => write!(f, "Channel closed"),
            ProtocolError::Violated => write!(f, "Channel protocol violated"),
        }
    }
}

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