[][src]Struct safina::DeadlineFuture

#[must_use = "futures stay idle unless you await them"]pub struct DeadlineFuture<R, Fut> where
    Fut: 'static + Send + Unpin + Future<Output = R>, 
{ /* fields omitted */ }

A future wrapper that returns DeadlineExceeded at a specified deadline.

It is returned by with_deadline and with_timeout.

Implementations

impl<R, Fut> DeadlineFuture<R, Fut> where
    Fut: 'static + Send + Unpin + Future<Output = R>, 
[src]

pub fn new(inner: Fut, deadline: Instant) -> DeadlineFuture<R, Fut>

Notable traits for DeadlineFuture<R, Fut>

impl<R, Fut> Future for DeadlineFuture<R, Fut> where
    Fut: 'static + Send + Unpin + Future<Output = R>, 
type Output = Result<R, DeadlineError>;
[src]

Makes a future that awaits inner, but returns DeadlineError after deadline.

Note that inner must be Unpin. Use std::boxed::Box::pin to make it Unpin. Or use pin_utils::pin_mut to do it with unsafe code that does not allocate memory.

Trait Implementations

impl<R, Fut> Future for DeadlineFuture<R, Fut> where
    Fut: 'static + Send + Unpin + Future<Output = R>, 
[src]

type Output = Result<R, DeadlineError>

The type of value produced on completion.

Auto Trait Implementations

impl<R, Fut> RefUnwindSafe for DeadlineFuture<R, Fut> where
    Fut: RefUnwindSafe
[src]

impl<R, Fut> Send for DeadlineFuture<R, Fut>[src]

impl<R, Fut> Sync for DeadlineFuture<R, Fut> where
    Fut: Sync
[src]

impl<R, Fut> Unpin for DeadlineFuture<R, Fut>[src]

impl<R, Fut> UnwindSafe for DeadlineFuture<R, Fut> where
    Fut: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.