Struct Consumer 

pub struct Consumer { /* private fields */ }

Receives route announcements for a scope.

Created by Consumer::announced. Drop to unregister.

Implementations

impl AnnounceConsumer

pub async fn next(&mut self) -> Option<AnnounceUpdate>

Returns the next route announcement, update, or retraction, its prefix relative to this cursor’s root.

A retraction is only delivered for a previously announced prefix, and a repeated announcement for the same prefix is a metadata update. Returns None if the cursor is closed. The consumer is also a futures::Stream of the same updates.

pub fn poll_next(&mut self, waiter: &Waiter) -> Poll<Option<AnnounceUpdate>>

Poll for the next update, without blocking.

Returns Poll::Ready(Some(_)) for an update, Poll::Ready(None) if the cursor is closed, or Poll::Pending after registering waiter to be notified when the next update arrives.

pub fn try_next(&mut self) -> Option<AnnounceUpdate>

Returns the next update without blocking.

Returns None if there is no update available; NOT because the cursor is closed. Use Self::is_closed to check if the cursor is closed.

pub fn is_closed(&self) -> bool

Returns true if the cursor is closed (no more updates will arrive).

pub fn root(&self) -> &Path<'_>

Returns the root that is automatically stripped from emitted prefixes.

pub fn absolute(&self, prefix: impl AsPath) -> Path<'_>

Converts an emitted prefix back to one rooted at the origin.

Trait Implementations

impl Drop for AnnounceConsumer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Stream for AnnounceConsumer

type Item = AnnounceUpdate

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.