Struct websocket::receiver::Receiver

pub struct Receiver { /* fields omitted */ }

A Receiver that wraps a Reader and provides a default implementation using DataFrames and Messages.

Methods

impl Receiver

pub fn new(mask: bool) -> Receiver

Create a new Receiver using the specified Reader.

Trait Implementations

impl Receiver for Receiver

type F = DataFrame

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

type M = OwnedMessage

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

fn recv_dataframe<R>(&mut self, reader: &mut R) -> WebSocketResult<DataFrame> where
    R: Read, 

Reads a single data frame from the remote endpoint.

fn recv_message_dataframes<R>(
    &mut self,
    reader: &mut R
) -> WebSocketResult<Vec<DataFrame>> where
    R: Read, 

Returns the data frames that constitute one message.

Important traits for DataFrameIterator<'a, Recv, R>

impl<'a, Recv, R> Iterator for DataFrameIterator<'a, Recv, R> where
    Recv: 'a + Receiver,
    R: Read,  type Item = WebSocketResult<Recv::F>;

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.

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

Reads a single message from this receiver.

Important traits for MessageIterator<'a, Recv, R>

impl<'a, Recv, R> Iterator for MessageIterator<'a, Recv, R> where
    Recv: 'a + Receiver,
    R: Read,  type Item = WebSocketResult<Recv::M>;

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.