Enum ProtocolMessage 

pub enum ProtocolMessage<'a> {
    ClientPreamble(ClientPreamble<'a>),
    ServerPreamble(ServerPreamble<'a>),
    ClientAuthentication(ClientAuthentication<'a>),
    HandshakeCompletion,
    Data(&'a [u8]),
    UdpData(&'a [u8]),
    Error(ProtocolError<'a>),
    Shutdown,
}

A helper type for protocol messages.

This is the main message type for the protocol. It is used to send and receive messages over the network. It is also used to serialize and deserialize messages.

Variants

ClientPreamble(ClientPreamble<'a>)

ServerPreamble(ServerPreamble<'a>)

ClientAuthentication(ClientAuthentication<'a>)

HandshakeCompletion

Data(&'a [u8])

UdpData(&'a [u8])

Error(ProtocolError<'a>)

Shutdown

Implementations

impl ProtocolMessage<'_>

pub fn fail_if_error(&self) -> Res<&Self>

Checks if the message is an error.

If it is, returns the message wrapped in an error.

Trait Implementations

impl<'__de, 'a, __Context> BorrowDecode<'__de, __Context> for ProtocolMessage<'a>

where '__de: 'a,

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'a> Debug for ProtocolMessage<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Encode for ProtocolMessage<'a>

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl<'a> PartialEq for ProtocolMessage<'a>

fn eq(&self, other: &ProtocolMessage<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ProtocolMessage<'a>

impl<'a> StructuralPartialEq for ProtocolMessage<'a>