Struct RequestStream 

pub struct RequestStream<S> { /* private fields */ }

Decode S type into Stream of websocket Message. S type must impl Stream trait and output Result<T, E> as Stream::Item where T type impl AsRef<[u8]> trait. (&[u8] is needed for parsing messages)

Stream termination

This stream never returns None. Callers should expect one of the following outcomes:

• Ok(Message::Close(_)): The remote peer initiated a clean close. The caller should send a close frame back via ResponseSender and then stop polling.
• Err(WsError::Protocol(ProtocolError::RecvClosed)): The stream was polled after a close frame had already been received. The caller should have stopped polling after observing Message::Close.
• Err(WsError::Protocol(ProtocolError::UnexpectedEof)): The underlying transport ended without a close frame. This is an abnormal closure and the associated connection should not be reused.
• Err(WsError::Protocol(_)): A protocol violation occurred (e.g. bad opcode, continuation error). The connection should be dropped.
• Err(WsError::Stream(_)): The underlying stream produced an error.

Implementations

impl<S, T, E> RequestStream<S>

where S: Stream<Item = Result<T, E>>, T: AsRef<[u8]>,

pub fn new(stream: S) -> Self

pub fn with_codec(stream: S, codec: Codec) -> Self

pub fn inner_mut(&mut self) -> &mut S

pub fn codec_mut(&mut self) -> &mut Codec

pub fn response_stream(&self) -> (ResponseStream, ResponseSender)

Make a ResponseStream from current DecodeStream.

This API is to share the same codec for both decode and encode stream.

Trait Implementations

impl<S, T, E> Stream for RequestStream<S>

where S: Stream<Item = Result<T, E>>, T: AsRef<[u8]>,

type Item = Result<Message, WsError<E>>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, S> Unpin for RequestStream<S>

where PinnedFieldsOf<__Origin<'__pin, S>>: Unpin,