Struct WeightedSender 

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

The sending half of a weighted channel. Cloneable and shareable across tasks.

Implementations

impl<T: Weigh> WeightedSender<T>

pub async fn send(&self, value: T) -> Result<(), SendError<T>>

Send a message, waiting until there is room in the budget for its weight.

Waits (asynchronously) while the messages already in the channel plus this one would exceed the budget, then delivers it. A message that weighs more than the whole budget is handled per the channel’s Oversized policy.

Errors

• SendError::Closed if the receiver has been dropped.
• SendError::TooLarge if the message weighs more than the budget and the policy is Oversized::Reject.

pub fn try_send(&self, value: T) -> Result<(), TrySendError<T>>

Try to send a message without waiting.

Like send, but never waits: if admitting the message would exceed the budget, or the count buffer is full, it returns TrySendError::Full right away instead of waiting for room. A message that weighs more than the whole budget is handled per the channel’s Oversized policy.

Errors

• TrySendError::Full if there is no room right now (weight budget or count buffer).
• TrySendError::Closed if the receiver has been dropped.
• TrySendError::TooLarge if the message weighs more than the budget and the policy is Oversized::Reject.

pub fn max_weight(&self) -> usize

The channel’s total weight budget (the value passed to Builder::new).

pub fn available_weight(&self) -> usize

Budget not currently reserved by messages in the channel, in weight units.

Trait Implementations

impl<T> Clone for WeightedSender<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for WeightedSender<T>

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

Formats the value using the given formatter.