Enum thingbuf::mpsc::errors::SendTimeoutError

#[non_exhaustive]
pub enum SendTimeoutError<T = ()> {
    Timeout(T),
    Closed(T),
}

Available on crate feature std only.

Error returned by the Sender::send_timeout or Sender::send_ref_timeout (and StaticSender::send_timeout/StaticSender::send_ref_timeout) methods (blocking only).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Timeout(T)

The data could not be sent on the channel because the channel is currently full and sending would require waiting for capacity.

Closed(T)

The data could not be sent because the Receiver half of the channel has been dropped.

Implementations

impl<T> SendTimeoutError<T>

pub fn is_timeout(&self) -> bool

Returns true if this error was returned because the channel is still full after the timeout has elapsed.

pub fn is_closed(&self) -> bool

Returns true if this error was returned because the channel has closed (e.g. the Receiver end has been dropped).

If this returns true, no future try_send or send operation on this channel will succeed.

pub fn into_inner(self) -> T

Unwraps the inner T value held by this error.

This method allows recovering the original message when sending to a channel has failed.

Trait Implementations

impl<T> Debug for SendTimeoutError<T>

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

Formats the value using the given formatter.

impl<T> Display for SendTimeoutError<T>

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

Formats the value using the given formatter.

impl<T> Error for SendTimeoutError<T>

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

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

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl<T: PartialEq> PartialEq for SendTimeoutError<T>

fn eq(&self, other: &SendTimeoutError<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for SendTimeoutError<T>

impl<T> StructuralPartialEq for SendTimeoutError<T>