Enum 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,

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>

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

Formats the value using the given formatter.

impl<T> Display for SendTimeoutError<T>

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)>

Returns 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> From<SendError<T>> for SendTimeoutError<T>

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

Converts to this type from the input type.

impl<T> PartialEq for SendTimeoutError<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Copy for SendTimeoutError<T>

where T: Copy,

impl<T> Eq for SendTimeoutError<T>

where T: Eq,

impl<T> StructuralPartialEq for SendTimeoutError<T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.