Struct iota_metrics::metered_channel::Permit

pub struct Permit<'a, T> { /* private fields */ }

A newtype for an mpsc::Permit which allows us to inject gauge accounting in the case the permit is dropped w/o sending

Implementations

impl<'a, T> Permit<'a, T>

pub fn new(permit: Permit<'a, T>, gauge_ref: &'a IntGauge) -> Permit<'a, T>

Creates a new Permit instance using the provided mpsc::Permit and a reference to an IntGauge. The Permit allows sending a message into a channel and is used to ensure a slot is available before sending.

pub fn send(self, value: T)

Sends a value into the channel using the held Permit. After sending the value, the function uses std::mem::forget(self) to skip the drop logic of the permit, avoiding double decrement of the gauge or other unintended side effects.

Trait Implementations

impl<T> Drop for Permit<'_, T>

fn drop(&mut self)

Custom drop logic for the Permit to handle cases where the permit is dropped without sending a value. This ensures that the occupancy of the channel is correctly updated by decrementing the associated gauge if the permit was not used. This prevents any overestimation of active items in the channel.