pub struct MeteredSender<T> { /* private fields */ }
Expand description
The sender component, tracking the number of items sent across it.
Implementations§
source§impl<T> MeteredSender<T>
impl<T> MeteredSender<T>
Methods from Deref<Target = Sender<MaybeTimeOfFlight<T>>>§
sourcepub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<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.
sourcepub fn start_send(&mut self, msg: T) -> Result<(), SendError>
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.
sourcepub fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), SendError>>
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.
sourcepub fn is_closed(&self) -> bool
pub fn is_closed(&self) -> bool
Returns whether this channel is closed without needing a context.
sourcepub fn close_channel(&mut self)
pub fn close_channel(&mut self)
Closes this channel from the sender side, preventing any new messages.
sourcepub fn disconnect(&mut self)
pub fn disconnect(&mut self)
Disconnects this sender from the channel, closing it if there are no more senders left.
sourcepub fn same_receiver(&self, other: &Sender<T>) -> bool
pub fn same_receiver(&self, other: &Sender<T>) -> bool
Returns whether the senders send to the same receiver.
sourcepub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool
pub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool
Returns whether the sender send to this receiver.
sourcepub fn hash_receiver<H>(&self, hasher: &mut H)where
H: Hasher,
pub fn hash_receiver<H>(&self, hasher: &mut H)where H: Hasher,
Hashes the receiver into the provided hasher