Struct Consumer 

pub struct Consumer { /* private fields */ }

The session’s side of a lease: reads the grant and learns when it changes or ends.

Dropping it ends the lease with Reason::Dropped; close says why.

Implementations

impl Consumer

pub fn fixed(grant: Grant) -> Self

A lease on a grant nobody drives: it never changes and is never revoked, so only the holder ends it. What a static or public grant admits under.

pub fn grant(&self) -> Grant

The grant as it stands now.

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

Poll for the next update: the new grant, or the reason the lease ended.

pub async fn changed(&mut self) -> Result<Grant, Reason>

Wait for the next update: the new grant, or the reason the lease ended.

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

Poll for the lease ending.

pub async fn closed(&self) -> Reason

Wait for the lease to end.

pub fn revalidate(&self)

Ask the producer to re-check now. A no-op on a fixed lease, which has nobody to ask.

pub fn close(self, reason: impl Into<Reason>, bytes: Bytes) -> Reason

End the lease with the session’s own close classification and the totals it moved, consuming the handle, and return the reason the lease ended with: reason, or the producer’s if it revoked first. Drop reports zero bytes.

Trait Implementations

impl Debug for Consumer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Consumer

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.