Struct websocket::receiver::Reader
[−]
[src]
pub struct Reader<R> where
R: Read, { pub stream: BufReader<R>, pub receiver: Receiver, }
This reader bundles an existing stream with a parsing algorithm.
It is used by the client in its .split()
function as the reading component.
Fields
stream: BufReader<R>
the stream to be read from
receiver: Receiver
the parser to parse bytes into messages
Methods
impl<R> Reader<R> where
R: Read,
[src]
R: Read,
pub fn recv_dataframe(&mut self) -> WebSocketResult<DataFrame>
[src]
Reads a single data frame from the remote endpoint.
ⓘImportant traits for DataFrameIterator<'a, Recv, R>pub fn incoming_dataframes(
&mut self
) -> DataFrameIterator<Receiver, BufReader<R>>
[src]
ⓘImportant traits for DataFrameIterator<'a, Recv, R>
&mut self
) -> DataFrameIterator<Receiver, BufReader<R>>
Returns an iterator over incoming data frames.
pub fn recv_message<I>(&mut self) -> WebSocketResult<OwnedMessage> where
I: Iterator<Item = DataFrame>,
[src]
I: Iterator<Item = DataFrame>,
Reads a single message from this receiver.
ⓘImportant traits for MessageIterator<'a, Recv, R>pub fn incoming_messages<'a>(
&'a mut self
) -> MessageIterator<'a, Receiver, BufReader<R>>
[src]
ⓘImportant traits for MessageIterator<'a, Recv, R>
&'a mut self
) -> MessageIterator<'a, Receiver, BufReader<R>>
An iterator over incoming messsages. This iterator will block until new messages arrive and will never halt.
impl<S> Reader<S> where
S: AsTcpStream + Stream + Read,
[src]
S: AsTcpStream + Stream + Read,
pub fn shutdown(&self) -> IoResult<()>
[src]
Closes the receiver side of the connection, will cause all pending and future IO to return immediately with an appropriate value.
pub fn shutdown_all(&self) -> IoResult<()>
[src]
Shuts down both Sender and Receiver, will cause all pending and future IO to return immediately with an appropriate value.