Struct websocket::receiver::Receiver

pub struct Receiver { /* private fields */ }

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.

Uses built-in limits for dataframe and message sizes.

pub fn new_with_limits( mask: bool, max_dataframe_size: usize, max_message_size: usize ) -> Receiver

Create a new Receiver using the specified Reader, with configurable limits

Sizes should not be larger than u32::MAX.

Note that max_message_size denotes message size where no new dataframes would be read, so actual maximum message size is larger.

Trait Implementations

impl Receiver for Receiver

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.

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 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) -> Result<Self::M, WebSocketError>

where R: Read,

Reads a single message from this receiver.

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.