[][src]Struct tokio_evacuate::Evacuate

pub struct Evacuate<F: Future> { /* fields omitted */ }

A future for safely "evacuating" a resource that is used by multiple parties.

Evacuate tracks a tripwire, the count of concurrent users, and an evacuation timeout, and functions in a two-step process: we must be tripped, and then we race to the timeout.

Until the tripwire completes, Evacuate will always return Async::NotReady. Once we detect that the tripwire has completed, however, we immediately spawn a timeout, based on the configured value, and race between the user count dropping to zero and the timeout firing.

The user count is updated by calls to Warden::increment and Warden::decrement.

Methods

impl<F: Future> Evacuate<F>
[src]

Creates a new Evacuate.

The given tripwire is used, and the internal timeout is set to the value of timeout_ms.

Returns both a Warden handle, used for incrementing and decrementing the user count, and Evacuate itself.

Trait Implementations

impl<F: Future> Future for Evacuate<F>
[src]

The type of error that this future will resolve with if it fails in a normal fashion. Read more

The type of value that this future will resolved with if it is successful. Read more

Block the current thread until this future is resolved. Read more

Map this future's result to a different type, returning a new future of the resulting type. Read more

Map this future's error to a different error, returning a new future. Read more

Map this future's error to any error implementing From for this future's Error, returning a new future. Read more

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

Execute another future after this one has resolved successfully. Read more

Execute another future if this one resolves with an error. Read more

Waits for either one of two futures to complete. Read more

Waits for either one of two differently-typed futures to complete. Read more

Joins the result of two futures, waiting for them both to complete. Read more

Same as join, but with more futures.

Same as join, but with more futures.

Same as join, but with more futures.

Convert this future into a single element stream. Read more

Flatten the execution of this future when the successful result of this future is itself another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Fuse a future such that poll will never again be called once it has completed. Read more

Do something with the item of a future, passing it on. Read more

Catches unwinding panics while polling the future. Read more

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

Auto Trait Implementations

impl<F> Send for Evacuate<F> where
    F: Send

impl<F> Sync for Evacuate<F> where
    F: Sync

Blanket Implementations

impl<T> From for T
[src]

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

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

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

The type returned in the event of a conversion error.

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

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

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

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

The type returned in the event of a conversion error.

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

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

The future that this type can be converted into.

The item that the future may resolve with.

The error that the future may resolve with.