Trait websocket::ws::Receiver

source · 
pub trait Receiver: Sized {
    type F: DataFrame;
    type M: Message;

    // Required methods
    fn recv_dataframe<R>(
        &mut self,
        reader: &mut R
    ) -> Result<Self::F, WebSocketError>
       where R: Read;
    fn recv_message_dataframes<R>(
        &mut self,
        reader: &mut R
    ) -> Result<Vec<Self::F>, WebSocketError>
       where R: Read;

    // Provided methods
    fn incoming_dataframes<'a, R>(
        &'a mut self,
        reader: &'a mut R
    ) -> DataFrameIterator<'a, Self, R> ⓘ
       where R: Read { ... }
    fn recv_message<R>(
        &mut self,
        reader: &mut R
    ) -> Result<Self::M, WebSocketError>
       where R: Read { ... }
    fn incoming_messages<'a, R>(
        &'a mut self,
        reader: &'a mut R
    ) -> MessageIterator<'a, Self, R> ⓘ
       where R: Read { ... }
}
Expand description

A trait for receiving data frames and messages.

Required Associated Types§

source

type F: DataFrame

The type of dataframe that incoming messages will be serialized to.

source

type M: Message

The type of message that incoming messages will be serialized to.

Required Methods§

source

fn recv_dataframe<R>( &mut self, reader: &mut R ) -> Result<Self::F, WebSocketError>
where R: Read,

Reads a single data frame from this receiver.

source

fn recv_message_dataframes<R>( &mut self, reader: &mut R ) -> Result<Vec<Self::F>, WebSocketError>
where R: Read,

Returns the data frames that constitute one message.

Provided Methods§

source

fn incoming_dataframes<'a, R>( &'a mut self, reader: &'a mut R ) -> DataFrameIterator<'a, Self, R> ⓘ
where R: Read,

Returns an iterator over incoming data frames.

source

fn recv_message<R>(&mut self, reader: &mut R) -> Result<Self::M, WebSocketError>
where R: Read,

Reads a single message from this receiver.

source

fn incoming_messages<'a, R>( &'a mut self, reader: &'a mut R ) -> MessageIterator<'a, Self, R> ⓘ
where R: Read,

Returns an iterator over incoming messages.

Object Safety§

This trait is not object safe.

Implementors§