Struct tokio_stream::wrappers::BroadcastStream

pub struct BroadcastStream<T> { /* fields omitted */ }

This is supported on crate feature sync only.

A wrapper around tokio::sync::broadcast::Receiver that implements Stream.

Implementations

impl<T: 'static + Clone + Send> BroadcastStream<T>

pub fn new(rx: Receiver<T>) -> Self

Create a new BroadcastStream.

Trait Implementations

impl<T> Debug for BroadcastStream<T>

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

Formats the value using the given formatter.

impl<T: 'static + Clone + Send> From<Receiver<T>> for BroadcastStream<T>

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

Performs the conversion.

impl<T: 'static + Clone + Send> Stream for BroadcastStream<T>

type Item = Result<T, BroadcastStreamRecvError>

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.