Enum SocketMessage 

pub enum SocketMessage {
    Binary(Vec<u8>),
    Text(String),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close,
}

Generic socket message.

Variants

Binary(Vec<u8>)

Binary message.

Text(String)

Text message.

Ping(Vec<u8>)

Ping message.

Pong(Vec<u8>)

Pong message.

Close

Close message.

Trait Implementations

impl Debug for SocketMessage

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

Formats the value using the given formatter.

impl From<Message> for SocketMessage

fn from(msg: WsMessage) -> Self

Converts to this type from the input type.

impl From<SocketMessage> for Message

fn from(msg: SocketMessage) -> WsMessage

Converts to this type from the input type.

impl From<WsMessage> for SocketMessage

fn from(msg: WsMessage) -> Self

Converts to this type from the input type.

impl<S> Sink<SocketMessage> for WebSocket<S>

where S: AsyncRead + AsyncWrite + Unpin,

type Error = Box<dyn Error + Sync + Send>

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: SocketMessage, ) -> 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 Sink<SocketMessage> for WebSocket

type Error = Box<dyn Error + Sync + Send>

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: SocketMessage, ) -> 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 TryFrom<SocketMessage> for WsMessage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: SocketMessage) -> Result<Self, Self::Error>

Performs the conversion.