Enum Message

pub enum Message<T> {
    Item(T),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close(Option<CloseFrame<'static>>),
}

A WebSocket message contain a value of a known type.

Variants

Item(T)

An item of type T.

Ping(Vec<u8>)

A ping message with the specified payload

The payload here must have a length less than 125 bytes

Pong(Vec<u8>)

A pong message with the specified payload

The payload here must have a length less than 125 bytes

Close(Option<CloseFrame<'static>>)

A close message with the optional close frame.

Trait Implementations

impl<T: Clone> Clone for Message<T>

fn clone(&self) -> Message<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Message<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Message<T>

fn eq(&self, other: &Message<T>) -> 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<S, R, C> Sink<Message<S>> for WebSocket<S, R, C>

where S: Serialize, C: Codec,

type Error = Error<<C as Codec>::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>, msg: Message<S>) -> 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: Eq> Eq for Message<T>

impl<T> StructuralPartialEq for Message<T>