Struct zbus::MessageStream

pub struct MessageStream { /* private fields */ }

A stream::Stream implementation that yields Message items.

You can convert a Connection to this type and back to Connection.

NOTE: You must ensure a MessageStream is continuously polled or you will experience hangs. If you don’t need to continuously poll the MessageStream but need to keep it around for later use, keep the connection around and convert it into a MessageStream when needed. The conversion is not an expensive operation so you don’t need to worry about performance, unless you do it very frequently. If you need to convert back and forth frequently, you may want to consider keeping both a connection and stream around.

Trait Implementations

impl Clone for MessageStream

fn clone(&self) -> MessageStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageStream

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

Formats the value using the given formatter.

impl From<&Connection> for MessageStream

fn from(conn: &Connection) -> Self

Converts to this type from the input type.

impl From<Connection> for MessageStream

fn from(conn: Connection) -> Self

Converts to this type from the input type.

impl From<MessageStream> for Connection

fn from(stream: MessageStream) -> Connection

Converts to this type from the input type.

impl FusedStream for MessageStream

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl OrderedStream for MessageStream

type Data = Result<Arc<Message>, Error>

The unordered data carried by this stream

type Ordering = MessageSequence

The type ordered by this stream.

fn poll_next_before(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    before: Option<&Self::Ordering>
) -> Poll<PollResult<Self::Ordering, Self::Data>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if needed, and returning NoneBefore if it is known that the stream will not produce any more values ordered before the given point.

fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>

The minimum value of the ordering for any future items.

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

Returns the bounds on the remaining length of the stream.

impl Stream for MessageStream

type Item = Result<Arc<Message>, Error>

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.