Struct polkadot_node_subsystem::gen::metered::UnboundedMeteredSender

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

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

Implementations

impl<T> UnboundedMeteredSender<T>

pub fn meter(&self) -> &Meter

Get an updated accessor object for all metrics collected.

pub fn unbounded_send( &self, msg: T, ) -> Result<(), TrySendError<MaybeTimeOfFlight<T>>>

Attempt to send message or fail immediately.

Methods from Deref<Target = UnboundedSender<MaybeTimeOfFlight<T>>>

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

Check if the channel is ready to receive a message.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&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 start_send(&mut self, msg: T) -> Result<(), SendError>

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

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

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

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

Returns whether the senders send to the same receiver.

pub fn is_connected_to(&self, receiver: &UnboundedReceiver<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

pub fn len(&self) -> usize

Return the number of messages in the queue or 0 if channel is disconnected.

pub fn is_empty(&self) -> bool

Return false is channel has no queued messages, true otherwise.

Trait Implementations

impl<T> Clone for UnboundedMeteredSender<T>

fn clone(&self) -> UnboundedMeteredSender<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for UnboundedMeteredSender<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for UnboundedMeteredSender<T>

type Target = UnboundedSender<MaybeTimeOfFlight<T>>

The resulting type after dereferencing.

fn deref(&self) -> &<UnboundedMeteredSender<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for UnboundedMeteredSender<T>

fn deref_mut(&mut self) -> &mut <UnboundedMeteredSender<T> as Deref>::Target

Mutably dereferences the value.