Enum tokio::sync::broadcast::error::TryRecvError

pub enum TryRecvError {
    Empty,
    Closed,
    Lagged(u64),
}

An error returned from the try_recv function on a Receiver.

Variants

Empty

The channel is currently empty. There are still active Sender handles, so data may yet become available.

Closed

There are no more active senders implying no further messages will ever be sent.

Lagged(u64)

The receiver lagged too far behind and has been forcibly disconnected. Attempting to receive again will return the oldest message still retained by the channel.

Includes the number of skipped messages.

Trait Implementations

impl Debug for TryRecvError

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

Formats the value using the given formatter.

impl Display for TryRecvError

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

Formats the value using the given formatter.

impl Error for TryRecvError

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<TryRecvError> for TryRecvError

fn eq(&self, other: &TryRecvError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TryRecvError) -> bool

This method tests for !=.

impl StructuralPartialEq for TryRecvError