Struct Consumer 

pub struct Consumer { /* private fields */ }

Receives announce / unannounce events for a subtree.

Created by Consumer::announced or AnnounceProducer::consume. Drop to unregister.

Implementations

impl AnnounceConsumer

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

Returns the next (un)announced broadcast and its path relative to this cursor’s root.

The broadcast will only be announced if it was previously unannounced. The same path won’t be announced/unannounced twice in a row; instead it toggles. Returns None if the cursor is closed.

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

Poll for the next (un)announced broadcast, 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<OriginAnnounce>

Returns the next (un)announced broadcast 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 prefix that is automatically stripped from emitted paths.

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

Converts a relative path to an absolute path.

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.