Enum crossbeam::channel::SendTimeoutError

pub enum SendTimeoutError<T> {
    Timeout(T),
    Disconnected(T),
}

An error returned from the send_timeout method.

The error contains the message being sent so it can be recovered.

Variants

Timeout(T)

The message could not be sent because the channel is full and the operation timed out.

If this is a zero-capacity channel, then the error indicates that there was no receiver available to receive the message and the operation timed out.

Disconnected(T)

The message could not be sent because the channel is disconnected.

Implementations

impl<T> SendTimeoutError<T>

pub fn into_inner(self) -> T

Unwraps the message.

Examples

use std::time::Duration;
use crossbeam_channel::unbounded;

let (s, r) = unbounded();

if let Err(err) = s.send_timeout("foo", Duration::from_secs(1)) {
    assert_eq!(err.into_inner(), "foo");
}

pub fn is_timeout(&self) -> bool

Returns true if the send operation timed out.

pub fn is_disconnected(&self) -> bool

Returns true if the send operation failed because the channel is disconnected.

Trait Implementations

impl<T> Clone for SendTimeoutError<T> where
    T: Clone, 

pub fn clone(&self) -> SendTimeoutError<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for SendTimeoutError<T>

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

Formats the value using the given formatter.

impl<T> Display for SendTimeoutError<T>

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

Formats the value using the given formatter.

impl<T> Error for SendTimeoutError<T> where
    T: Send, 

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

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

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

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

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

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

impl<T> From<SendError<T>> for SendTimeoutError<T>

pub fn from(err: SendError<T>) -> SendTimeoutError<T>

Performs the conversion.

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

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

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

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

This method tests for !=.

impl<T> Copy for SendTimeoutError<T> where
    T: Copy, 

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

impl<T> StructuralEq for SendTimeoutError<T>

impl<T> StructuralPartialEq for SendTimeoutError<T>