Struct iota_metrics::metered_channel::Receiver

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

An [mpsc::Receiver] with an [IntGauge] counting the number of currently queued items.

Implementations

impl<T> Receiver<T>

pub async fn recv(&mut self) -> Option<T>

Receives the next value for this receiver. Decrements the gauge in case of a successful recv.

pub fn try_recv(&mut self) -> Result<T, TryRecvError>

Attempts to receive the next value for this receiver. Decrements the gauge in case of a successful try_recv.

pub fn blocking_recv(&mut self) -> Option<T>

Receives a value from the channel in a blocking manner. When a value is received, the gauge is decremented to indicate that an item has been processed, and the total_gauge (if available) is incremented to keep track of the total number of received items. Returns the received value if successful, or None if the channel is closed.

pub fn close(&mut self)

Closes the receiving half of a channel without dropping it.

pub fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Option<T>>

Polls to receive the next message on this channel. Decrements the gauge in case of a successful poll_recv.

Trait Implementations

impl<T> AsMut<Receiver<T>> for ReceiverStream<T>

fn as_mut(&mut self) -> &mut Receiver<T>

Gets a mutable reference to the inner Receiver.

impl<T> AsRef<Receiver<T>> for ReceiverStream<T>

fn as_ref(&self) -> &Receiver<T>

Gets a reference to the inner Receiver.

impl<T: Debug> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> From<Receiver<T>> for ReceiverStream<T>

fn from(recv: Receiver<T>) -> Self

Converts a Receiver into a ReceiverStream.

impl<T> Unpin for Receiver<T>