Enum ProtocolMessage

pub enum ProtocolMessage {
    ClientPreamble(ClientPreamble),
    ServerPreamble(ServerPreamble),
    ClientAuthentication(ClientAuthentication),
    HandshakeCompletion,
    Data(Vec<u8>),
    UdpData(Vec<u8>),
    Error(ProtocolError),
}

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)

ServerPreamble(ServerPreamble)

ClientAuthentication(ClientAuthentication)

HandshakeCompletion

Data(Vec<u8>)

UdpData(Vec<u8>)

Error(ProtocolError)

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 Debug for ProtocolMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProtocolMessage

fn eq(&self, other: &ProtocolMessage) -> 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 Serialize for ProtocolMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<R, W> Sink<ProtocolMessage> for BuffedStream<R, W>

where R: Unpin, W: AsyncWrite + Unpin,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: ProtocolMessage, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Sink<ProtocolMessage> for BuffedStreamWriteHalf<T>

where T: AsyncWrite + Unpin,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: ProtocolMessage, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl BincodeMessage for ProtocolMessage

impl Eq for ProtocolMessage

impl StructuralPartialEq for ProtocolMessage