Trait websocket::ws::receiver::Receiver

[+] Show declaration

pub trait Receiver: Sized {
    type F: DataFrame;
    type M: Message;
    fn recv_dataframe<R>(&mut self, reader: &mut R) -> WebSocketResult<Self::F>
    where
        R: Read;
    fn recv_message_dataframes<R>(
        &mut self, 
        reader: &mut R
    ) -> WebSocketResult<Vec<Self::F>>
    where
        R: Read;

    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) -> WebSocketResult<Self::M>
    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.

Associated Types

type F: DataFrame[−]

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

type M: Message[−]

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

Required Methods

fn recv_dataframe<R>(&mut self, reader: &mut R) -> WebSocketResult<Self::F> where
    R: Read, [−]

Reads a single data frame from this receiver.

fn recv_message_dataframes<R>(
    &mut self,
    reader: &mut R
) -> WebSocketResult<Vec<Self::F>> where
    R: Read, [−]

Returns the data frames that constitute one message.

Provided Methods

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.

Implementors

impl Receiver for Receiver

[−]

type F = DataFrame

type M = OwnedMessage

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,

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

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,