Enum `RecvTimeoutError`

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.

Implementations

`impl<T> Any for RecvTimeoutError<T>`

fn type_id(self: &Self) -> TypeId

`impl<T> Borrow for RecvTimeoutError<T>`

fn borrow(self: &Self) -> &T

`impl<T> BorrowMut for RecvTimeoutError<T>`

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

`impl<T> Debug for RecvTimeoutError<T>`

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

`impl<T> Display for RecvTimeoutError<T>`

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

`impl<T> Error for RecvTimeoutError<T>`

`impl<T> Freeze for RecvTimeoutError<T>`

`impl<T> From 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.

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

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T> RefUnwindSafe for RecvTimeoutError<T>`

`impl<T> Send for RecvTimeoutError<T>`

`impl<T> Sync for RecvTimeoutError<T>`

`impl<T> ToString for RecvTimeoutError<T>`

fn to_string(self: &Self) -> String

`impl<T> Unpin for RecvTimeoutError<T>`

`impl<T> UnwindSafe for RecvTimeoutError<T>`

`impl<T, U> Into for RecvTimeoutError<T>`

fn into(self: 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 for RecvTimeoutError<T>`

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

`impl<T, U> TryInto for RecvTimeoutError<T>`

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