Struct WeightedReceiver 

pub struct WeightedReceiver<T> { /* private fields */ }

The receiving half of a weighted channel.

Dropping the receiver closes the channel: any producer waiting for room in WeightedSender::send wakes with SendError::Closed.

Implementations

impl<T> WeightedReceiver<T>

pub async fn recv(&mut self) -> Option<Lease<T>>

Receive the next message, or None once every sender is dropped and the channel is drained.

The returned Lease holds the message’s budget until it is dropped, so hold it while the message is in use, or call Lease::into_inner to take the value and free the budget now.

pub fn close(&mut self)

Close the channel without dropping the receiver: senders stop, but messages already in the channel can still be drained with recv.

Trait Implementations

impl<T> Debug for WeightedReceiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for WeightedReceiver<T>

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.