pub struct Receiver { /* private fields */ }
Expand description
A Receiver that wraps a Reader and provides a default implementation using DataFrames and Messages.
Implementations
sourceimpl Receiver
impl Receiver
sourcepub fn new(mask: bool) -> Receiver
pub fn new(mask: bool) -> Receiver
Create a new Receiver using the specified Reader.
Uses built-in limits for dataframe and message sizes.
sourcepub fn new_with_limits(
mask: bool,
max_dataframe_size: usize,
max_message_size: usize
) -> Receiver
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
sourceimpl Receiver for Receiver
impl Receiver for Receiver
sourcefn recv_dataframe<R>(&mut self, reader: &mut R) -> WebSocketResult<DataFrame> where
R: Read,
fn recv_dataframe<R>(&mut self, reader: &mut R) -> WebSocketResult<DataFrame> where
R: Read,
Reads a single data frame from the remote endpoint.
sourcefn recv_message_dataframes<R>(
&mut self,
reader: &mut R
) -> WebSocketResult<Vec<DataFrame>> where
R: Read,
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 M = OwnedMessage
type M = OwnedMessage
The type of message that incoming messages will be serialized to.
sourcefn incoming_dataframes<R>(
&'a mut self,
reader: &'a mut R
) -> DataFrameIterator<'a, Self, R>ⓘNotable traits for DataFrameIterator<'a, Recv, R>impl<'a, Recv, R> Iterator for DataFrameIterator<'a, Recv, R> where
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::F, WebSocketError>;
where
R: Read,
fn incoming_dataframes<R>(
&'a mut self,
reader: &'a mut R
) -> DataFrameIterator<'a, Self, R>ⓘNotable traits for DataFrameIterator<'a, Recv, R>impl<'a, Recv, R> Iterator for DataFrameIterator<'a, Recv, R> where
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::F, WebSocketError>;
where
R: Read,
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::F, WebSocketError>;
Returns an iterator over incoming data frames.
sourcefn recv_message<R>(&mut self, reader: &mut R) -> Result<Self::M, WebSocketError> where
R: Read,
fn recv_message<R>(&mut self, reader: &mut R) -> Result<Self::M, WebSocketError> where
R: Read,
Reads a single message from this receiver.
sourcefn incoming_messages<R>(
&'a mut self,
reader: &'a mut R
) -> MessageIterator<'a, Self, R>ⓘNotable traits for MessageIterator<'a, Recv, R>impl<'a, Recv, R> Iterator for MessageIterator<'a, Recv, R> where
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::M, WebSocketError>;
where
R: Read,
fn incoming_messages<R>(
&'a mut self,
reader: &'a mut R
) -> MessageIterator<'a, Self, R>ⓘNotable traits for MessageIterator<'a, Recv, R>impl<'a, Recv, R> Iterator for MessageIterator<'a, Recv, R> where
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::M, WebSocketError>;
where
R: Read,
Recv: 'a + Receiver,
R: Read, type Item = Result<<Recv as Receiver>::M, WebSocketError>;
Returns an iterator over incoming messages.
Auto Trait Implementations
impl RefUnwindSafe for Receiver
impl Send for Receiver
impl Sync for Receiver
impl Unpin for Receiver
impl UnwindSafe for Receiver
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more