Struct OriginConsumer

pub struct OriginConsumer { /* private fields */ }

Consumes announced broadcasts matching against an optional prefix.

Implementations

impl OriginConsumer

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

Returns the next (un)announced broadcast and the absolute path.

The broadcast will only be announced if it was previously unannounced. The same path won’t be announced/unannounced twice, instead it will toggle. Returns None if the consumer is closed.

Note: The returned path is absolute and will always match this consumer’s prefix.

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

Returns the next (un)announced broadcast and the absolute path without blocking.

Returns None if there is no update available; NOT because the consumer is closed. You have to use is_closed to check if the consumer is closed.

pub fn consume(&self) -> OriginConsumer

pub fn consume_broadcast(&self, path: impl AsPath) -> Option<BroadcastConsumer>

Get a specific broadcast by path.

TODO This should include announcement support.

Returns None if the path hasn’t been announced yet.

pub fn consume_only(&self, prefixes: &[Path<'_>]) -> Option<OriginConsumer>

Returns a new OriginConsumer that only consumes broadcasts matching one of the prefixes.

Returns None if there are no legal prefixes (would always return None).

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

Returns the prefix that is automatically stripped from all paths.

pub fn allowed(&self) -> impl Iterator<Item = &Path<'_>>

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

Converts a relative path to an absolute path.

Trait Implementations

impl Drop for OriginConsumer

fn drop(&mut self)

Executes the destructor for this type.