Struct metered_channel::MeteredSender

pub struct MeteredSender<T> { /* fields omitted */ }

The sender component, tracking the number of items sent across it.

Implementations

impl<T> MeteredSender<T>

pub fn meter(&self) -> &Meter

Get an updated accessor object for all metrics collected.

pub async fn send(&mut self, item: T) -> Result<(), SendError> where
    Self: Unpin, 

Send message, wait until capacity is available.

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

Attempt to send message or fail immediately.

Methods from Deref<Target = Sender<T>>

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

Attempts to send a message on this Sender, returning the message if there was an error.

pub fn start_send(&mut self, msg: T) -> Result<(), SendError>

Send a message on the channel.

This function should only be called after poll_ready has reported that the channel is ready to receive a message.

pub fn poll_ready(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<(), SendError>>

Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.

Return value

This method returns:

• Poll::Ready(Ok(_)) if there is sufficient capacity;
• Poll::Pending if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;
• Poll::Ready(Err(SendError)) if the receiver has been dropped.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&mut self)

Closes this channel from the sender side, preventing any new messages.

pub fn disconnect(&mut self)

Disconnects this sender from the channel, closing it if there are no more senders left.

pub fn same_receiver(&self, other: &Sender<T>) -> bool

Returns whether the senders send to the same receiver.

pub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool

Returns whether the sender send to this receiver.

pub fn hash_receiver<H>(&self, hasher: &mut H) where
    H: Hasher, 

Hashes the receiver into the provided hasher

Trait Implementations

impl<T> Clone for MeteredSender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MeteredSender<T>

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

Formats the value using the given formatter.

impl<T> Deref for MeteredSender<T>

type Target = Sender<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for MeteredSender<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.