Struct tokio_stream::wrappers::UnboundedReceiverStream

pub struct UnboundedReceiverStream<T> { /* private fields */ }

A wrapper around tokio::sync::mpsc::UnboundedReceiver that implements Stream.

Implementations

impl<T> UnboundedReceiverStream<T>

pub fn new(recv: UnboundedReceiver<T>) -> Self

Create a new UnboundedReceiverStream.

pub fn into_inner(self) -> UnboundedReceiver<T>

Get back the inner UnboundedReceiver.

pub fn close(&mut self)

Closes the receiving half of a channel without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

Trait Implementations

impl<T> AsMut<UnboundedReceiver<T>> for UnboundedReceiverStream<T>

fn as_mut(&mut self) -> &mut UnboundedReceiver<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<UnboundedReceiver<T>> for UnboundedReceiverStream<T>

fn as_ref(&self) -> &UnboundedReceiver<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Debug> Debug for UnboundedReceiverStream<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<UnboundedReceiver<T>> for UnboundedReceiverStream<T>

fn from(recv: UnboundedReceiver<T>) -> Self

Converts to this type from the input type.

impl<T> Stream for UnboundedReceiverStream<T>

type Item = T

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.