[][src]Struct tokio_evacuate::Evacuate

pub struct Evacuate { /* 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.

Evacuate can be cloned, and all clones will become ready at the same time.

Methods

impl Evacuate[src]

pub fn new<F>(tripwire: F, timeout_ms: u64) -> (Warden, Evacuate, Runner<F>) where
    F: Future + Send + 'static, 
[src]

Creates a new Evacuate.

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

Returns a Warden handle, used for incrementing and decrementing the user count, an Evacuate future, which callers can select/poll against directly, and a Runner future which must be spawned manually to drive the inner behavior of Evacuate.

If you're using Tokio, you can call [default_executor] to spawn the runner on the default executor.

pub fn default_executor<F>(
    tripwire: F,
    timeout_ms: u64
) -> Result<(Warden, Evacuate), SpawnError> where
    F: Future + Send + 'static, 
[src]

Creates a new Evacuate, based on the default executor.

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

Returns a Warden handle, used for incrementing and decrementing the user count, and an Evacuate future, which callers can select/poll against directly.

This functions spawns a background task on the default executor which drives the state machine powering Evacuate. This function must be called from within a running task.

Trait Implementations

impl Clone for Evacuate[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Drop for Evacuate[src]

impl Future for Evacuate[src]

type Error = ()

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

type Item = ()

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

fn wait(self) -> Result<Self::Item, Self::Error>[src]

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

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 
[src]

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

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 
[src]

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

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 
[src]

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

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 
[src]

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

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 
[src]

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

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 
[src]

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

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 
[src]

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

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture
[src]

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

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 
[src]

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

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 
[src]

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 
[src]

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 
[src]

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>[src]

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 
[src]

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

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error
[src]

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

fn fuse(self) -> Fuse<Self>[src]

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

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 
[src]

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

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe
[src]

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self>[src]

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

Auto Trait Implementations

impl Send for Evacuate

impl Sync for Evacuate

Blanket Implementations

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T> From for T[src]

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

type Error = Infallible

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> BorrowMut for T where
    T: ?Sized
[src]

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

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

The type returned in the event of a conversion error.

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

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

impl<T> Erased for T