Embassy
embassy-time

Crates

git

Versions

default

Flavors

embassy_time

Trait WithTimeout

Source 
pub trait WithTimeout: Sized {
    type Output;

    // Required methods
    fn with_timeout(self, timeout: Duration) -> TimeoutFuture<Self>;
    fn with_deadline(self, at: Instant) -> TimeoutFuture<Self>;
}
Expand description

Provides functions to run a given future with a timeout or a deadline.

Required Associated Types§

Source

type Output

Output type of the future.

Required Methods§

Source

fn with_timeout(self, timeout: Duration) -> TimeoutFuture<Self>

Runs a given future with a timeout.

If the future completes before the timeout, its output is returned. Otherwise, on timeout, work on the future is stopped (poll is no longer called), the future is dropped and Err(TimeoutError) is returned.

Source

fn with_deadline(self, at: Instant) -> TimeoutFuture<Self>

Runs a given future with a deadline time.

If the future completes before the deadline, its output is returned. Otherwise, on timeout, work on the future is stopped (poll is no longer called), the future is dropped and Err(TimeoutError) is returned.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§