Struct Consumer 

pub struct Consumer { /* private fields */ }

Consumes bandwidth estimates, allowing reads and async change notifications.

Implementations

impl Consumer

pub fn peek(&self) -> Option<u64>

Get the current bandwidth estimate synchronously.

pub fn poll_changed(&mut self, waiter: &Waiter) -> Poll<Result<Option<u64>>>

Poll for a bandwidth change without blocking.

Ok(None) means the estimate is unavailable for now: the backend stopped reporting one, or the handle spans reconnects and is between sessions. Err means the producer is gone and no further change will ever arrive. They’re distinct because a caller holds its current rate for the first and stops watching for the second.

A backend with no bandwidth estimation at all yields no Consumer in the first place, so that case never reaches here.

pub async fn changed(&mut self) -> Result<Option<u64>>

Block until the bandwidth estimate changes, returning the new value, or None when the estimate has become unavailable.

Errors

Returns an error once the producer is closed or dropped, so a caller can stop watching. See poll_changed.

Trait Implementations

impl Clone for Consumer

fn clone(&self) -> Consumer

Returns a duplicate of the value.

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

Performs copy-assignment from source.