Struct UserOutboundReceiver 

pub struct UserOutboundReceiver {
    messages: Receiver<QueuedUserOutbound>,
    overflow: Receiver<Option<UserOutboundOverflow>>,
    metrics: Arc<RuntimeMetrics>,
    queued_bytes: Arc<AtomicUsize>,
}

Fields

messages: Receiver<QueuedUserOutbound>

overflow: Receiver<Option<UserOutboundOverflow>>

metrics: Arc<RuntimeMetrics>

queued_bytes: Arc<AtomicUsize>

Implementations

impl UserOutboundReceiver

pub fn has_overflowed(&self) -> bool

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

Receives queued output without observing overflow.

User-session loops should use Self::recv_event.

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

Attempts to receive queued output without observing overflow.

User-session loops should use Self::recv_event.

Errors

Returns [mpsc::error::TryRecvError::Empty] when no output is queued and [mpsc::error::TryRecvError::Disconnected] when every sender is dropped.

pub async fn recv_event(&mut self) -> UserOutboundEvent

Receives the next queue event with overflow prioritized over queued output.

Trait Implementations

impl Debug for UserOutboundReceiver

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

Formats the value using the given formatter.

impl Drop for UserOutboundReceiver

fn drop(&mut self)

Executes the destructor for this type.