RecvTimeoutError in std::sync::oneshot - Rust
Description: An error returned from the `recv_timeout` or `recv_deadline` methods.

## RecvTimeoutError

# Enum RecvTimeoutError

Source

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

🔬This is a nightly-only experimental API. (`oneshot_channel` #143674)
Expand description

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

🔬This is a nightly-only experimental API. (`oneshot_channel` #143674)

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

🔬This is a nightly-only experimental API. (`oneshot_channel` #143674)

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

## Trait Implementations§

Source§

### impl<T> Debug for RecvTimeoutError<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T> Display for RecvTimeoutError<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T> Error for RecvTimeoutError<T>

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

#### fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · Source§

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

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

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

🔬This is a nightly-only experimental API. (`error_generic_member_access` #99301)
Provides type-based access to context intended for error reports. Read more
Source§

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

Source§

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

§

### impl<T> RefUnwindSafe for RecvTimeoutError<T>

§

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

§

### impl<T> Sync for RecvTimeoutError<T>

§

### impl<T> Unpin for RecvTimeoutError<T>

§

### impl<T> UnwindSafe for RecvTimeoutError<T>

## Blanket Implementations§

Source§

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

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

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

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

Source§

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

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. Read more
Source§

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

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.