Enum RecvTimeoutError

pub enum RecvTimeoutError<T>

An error returned from the recv_timeout or recv_deadline methods.

Examples

Usage of this error is similar to TryRecvError.

#![feature(oneshot_channel)]
use std::sync::oneshot::{self, RecvTimeoutError};
use std::thread;
use std::time::Duration;

let (sender, receiver) = oneshot::channel();

let send_failure = thread::spawn(move || {
    // Simulate a long computation that takes longer than our timeout.
    thread::sleep(Duration::from_millis(250));

    // This will likely fail to send because we drop the receiver in the main thread.
    sender.send("Goodbye!".to_string()).unwrap();
});

// Try to receive the message with a short timeout.
match receiver.recv_timeout(Duration::from_millis(10)) {
    Ok(msg) => println!("Received: {}", msg),
    Err(RecvTimeoutError::Timeout(rx)) => {
        println!("Timed out waiting for message!");

        // Note that you can reuse the receiver without dropping it.
        drop(rx);
    },
    Err(RecvTimeoutError::Disconnected) => println!("Sender dropped!"),
}

send_failure.join().unwrap_err();

Variants

Timeout(Receiver<T>)

The Sender has not sent a message yet, but it might in the future (as it has not yet disconnected). This variant contains the Receiver that either recv_timeout or recv_deadline took ownership over.

Disconnected

The corresponding Sender half of this channel has become disconnected, and there will never be any more data sent over the channel.

Trait Implementations

impl<T> Debug for RecvTimeoutError<T>

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

impl<T> Display for RecvTimeoutError<T>

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

impl<T> Error for RecvTimeoutError<T>

impl<T> From<RecvError> for RecvTimeoutError<T>

fn from(err: RecvError) -> RecvTimeoutError<T>

Converts a RecvError into a RecvTimeoutError.

This conversion always returns RecvTimeoutError::Disconnected.

No data is allocated on the heap.

Auto Trait Implementations

impl<T> Freeze for RecvTimeoutError<T> where Receiver<T>: Freeze,

impl<T> RefUnwindSafe for RecvTimeoutError<T> where Receiver<T>: RefUnwindSafe,

impl<T> Send for RecvTimeoutError<T> where Receiver<T>: Send,

impl<T> Sync for RecvTimeoutError<T> where Receiver<T>: Sync,

impl<T> Unpin for RecvTimeoutError<T> where Receiver<T>: Unpin,

impl<T> UnsafeUnpin for RecvTimeoutError<T> where Receiver<T>: UnsafeUnpin,

impl<T> UnwindSafe for RecvTimeoutError<T> where Receiver<T>: UnwindSafe,

Blanket Implementations

impl<T> Any for RecvTimeoutError<T> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for RecvTimeoutError<T> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for RecvTimeoutError<T> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for RecvTimeoutError<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for RecvTimeoutError<T> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for RecvTimeoutError<T>

impl<T> ToString for RecvTimeoutError<T> where T: Display + ?Sized,

fn to_string(&self) -> String

impl<T, U> Into<U> for RecvTimeoutError<T> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for RecvTimeoutError<T> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for RecvTimeoutError<T> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>