Struct websocket::receiver::Receiver

[+] Show declaration

pub struct Receiver { /* fields omitted */ }

[−] Expand description

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

Implementations

impl Receiver[−]

pub fn new(mask: bool) -> Receiver[−]

Create a new Receiver using the specified Reader.

Trait Implementations

impl Receiver for Receiver[+]

[+] Show hidden undocumented items

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.

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

Returns an iterator over incoming data frames.

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

Reads a single message from this receiver.

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

Returns an iterator over incoming messages.