Struct Consumer 

pub struct Consumer { /* private fields */ }

Subscribe to arbitrary broadcast/tracks.

Implementations

impl Consumer

pub fn info(&self) -> &Info

The broadcast’s metadata, as reached through this handle.

pub fn track(&self, name: &str) -> Result<Consumer, Error>

Get a handle to a track on this broadcast.

pub fn demand(&self) -> Demand

A watch-only handle to the broadcast’s demand. See Demand.

The consumer-side sibling of Producer::demand, for a holder that has only a read handle. Holding this handle, or the Consumer it came from, is not itself demand.

Demand going away is Demand::unused resolving. The broadcast going away is Error::Dropped, which here means the upstream producer ended.

pub async fn closed(&self) -> Error

Block until the broadcast is closed, by Producer::finish, Producer::abort, or every producer dropping, and return the cause.

Returns the error passed to Producer::abort, or Error::Dropped for a Producer::finish or a dropped producer (check Self::is_finished to tell those apart).

pub fn is_closed(&self) -> bool

Returns true if every Producer has been dropped.

pub fn is_finished(&self) -> bool

Whether the broadcast ended via a deliberate Producer::finish, as opposed to aborting or losing its producer. false while the broadcast is still live.

pub fn poll_closed(&self, waiter: &Waiter) -> Poll<()>

Register a kio::Waiter that fires when the broadcast closes.

Returns Poll::Ready if already closed, otherwise Poll::Pending after arming the waiter. Useful for composing close-detection into a larger poll without spawning a task per broadcast.

pub fn is_clone(&self, other: &Self) -> bool

Check if this is the exact same instance of a broadcast.

Trait Implementations

impl Clone for Consumer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Consume<Consumer> for Producer

fn consume(&self) -> Consumer

Derive a read view (a consumer) from this handle.

impl Consume<Consumer> for Consumer

fn consume(&self) -> Consumer

Derive a read view (a consumer) from this handle.