Struct iota_metrics::monitored_mpsc::Sender

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

Wraps [mpsc::Sender] with gauges counting the sent and inflight items.

Implementations

impl<T> Sender<T>

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

Sends a value, waiting until there is capacity. Increments the gauge in case of a successful send.

pub async fn closed(&self)

Completes when the receiver has dropped.

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

Attempts to immediately send a message on this Sender Increments the gauge in case of a successful try_send.

pub fn is_closed(&self) -> bool

Checks if the channel has been closed. This happens when the Receiver is dropped, or when the Receiver::close method is called.

pub async fn reserve(&self) -> Result<Permit<'_, T>, SendError<()>>

Waits for channel capacity. Once capacity to send one message is available, it is reserved for the caller. Increments the gauge in case of a successful reserve.

pub fn try_reserve(&self) -> Result<Permit<'_, T>, TrySendError<()>>

Tries to acquire a slot in the channel without waiting for the slot to become available. Increments the gauge in case of a successful try_reserve.

pub fn capacity(&self) -> usize

Returns the current capacity of the channel.

pub fn downgrade(&self) -> WeakSender<T>

Downgrades the current Sender to a WeakSender, which holds a weak reference to the underlying channel. This allows the channel to be safely dropped without affecting the weak reference, which can later be upgraded back to a strong reference if needed.

Trait Implementations

impl<T> Clone for Sender<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 Sender<T>

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

Formats the value using the given formatter.

impl<T: Send> WithPermit<T> for Sender<T>

fn with_permit<'life0, 'async_trait, F>( &'life0 self, f: F, ) -> Pin<Box<dyn Future<Output = Option<(Permit<'_, T>, F::Output)>> + Send + 'async_trait>>

where F: 'async_trait + Future + Send, Self: 'async_trait, 'life0: 'async_trait,

Asynchronously reserves a permit for sending a message and then executes the given future (f). If a permit is successfully reserved, it returns a tuple containing the Permit and the result of the future (F::Output). If the permit reservation fails, None is returned, indicating that no slot is available. This method ensures that the future only proceeds if the channel has available capacity, allowing for controlled access to the channel.