Struct futures_retry::FutureRetry
source · pub struct FutureRetry<F, R>where
F: FutureFactory,{ /* private fields */ }
Expand description
A future that transparently launches an underlying future (created by a provided factory each time) as many times as needed to get things done.
It is useful fot situations when you need to make several attempts, e.g. for establishing connections, RPC calls.
There is also a type to handle Stream
errors: StreamRetry
.
Implementations§
source§impl<F: FutureFactory, R> FutureRetry<F, R>
impl<F: FutureFactory, R> FutureRetry<F, R>
sourcepub fn new(factory: F, error_action: R) -> Self
pub fn new(factory: F, error_action: R) -> Self
Creates a FutureRetry
using a provided factory and an object of ErrorHandler
type that
decides on a retry-policy depending on an encountered error.
Please refer to the tcp-client
example in the examples
folder to have a look at a
possible usage.
Arguments
factory
: a factory that creates futures,error_action
: a type that handles an error and decides which route to take: simply try again, wait and then try, or give up (on a critical error for exapmle).
Trait Implementations§
source§impl<F: FutureFactory, R> Future for FutureRetry<F, R>where
R: ErrorHandler<<F::FutureItem as Future>::Error>,
impl<F: FutureFactory, R> Future for FutureRetry<F, R>where
R: ErrorHandler<<F::FutureItem as Future>::Error>,
§type Item = <<F as FutureFactory>::FutureItem as Future>::Item
type Item = <<F as FutureFactory>::FutureItem as Future>::Item
The type of value that this future will resolved with if it is
successful. Read more
§type Error = <R as ErrorHandler<<<F as FutureFactory>::FutureItem as Future>::Error>>::OutError
type Error = <R as ErrorHandler<<<F as FutureFactory>::FutureItem as Future>::Error>>::OutError
The type of error that this future will resolve with if it fails in a
normal fashion. Read more
source§fn poll(&mut self) -> Poll<Self::Item, Self::Error>
fn poll(&mut self) -> Poll<Self::Item, Self::Error>
Query this future to see if its value has become available, registering
interest if it is not. Read more
source§fn wait(self) -> Result<Self::Item, Self::Error>where
Self: Sized,
fn wait(self) -> Result<Self::Item, Self::Error>where
Self: Sized,
Block the current thread until this future is resolved. Read more
source§fn map<F, U>(self, f: F) -> Map<Self, F>where
F: FnOnce(Self::Item) -> U,
Self: Sized,
fn map<F, U>(self, f: F) -> Map<Self, F>where
F: FnOnce(Self::Item) -> U,
Self: Sized,
Map this future’s result to a different type, returning a new future of
the resulting type. Read more
source§fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,
fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,
Map this future’s error to a different error, returning a new future. Read more
source§fn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
fn from_err<E>(self) -> FromErr<Self, E>where
E: From<Self::Error>,
Self: Sized,
Map this future’s error to any error implementing
From
for
this future’s Error
, returning a new future. Read moresource§fn then<F, B>(self, f: F) -> Then<Self, B, F>where
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
B: IntoFuture,
Self: Sized,
fn then<F, B>(self, f: F) -> Then<Self, B, F>where
F: FnOnce(Result<Self::Item, Self::Error>) -> B,
B: IntoFuture,
Self: Sized,
Chain on a computation for when a future finished, passing the result of
the future to the provided closure
f
. Read moresource§fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F>where
F: FnOnce(Self::Item) -> B,
B: IntoFuture<Error = Self::Error>,
Self: Sized,
fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F>where
F: FnOnce(Self::Item) -> B,
B: IntoFuture<Error = Self::Error>,
Self: Sized,
Execute another future after this one has resolved successfully. Read more
source§fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F>where
F: FnOnce(Self::Error) -> B,
B: IntoFuture<Item = Self::Item>,
Self: Sized,
fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F>where
F: FnOnce(Self::Error) -> B,
B: IntoFuture<Item = Self::Item>,
Self: Sized,
Execute another future if this one resolves with an error. Read more
source§fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future>where
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
Self: Sized,
fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future>where
B: IntoFuture<Item = Self::Item, Error = Self::Error>,
Self: Sized,
Waits for either one of two futures to complete. Read more
source§fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future>where
B: IntoFuture,
Self: Sized,
fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future>where
B: IntoFuture,
Self: Sized,
Waits for either one of two differently-typed futures to complete. Read more
source§fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future>where
B: IntoFuture<Error = Self::Error>,
Self: Sized,
fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future>where
B: IntoFuture<Error = Self::Error>,
Self: Sized,
Joins the result of two futures, waiting for them both to complete. Read more
source§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>,
Self: Sized,
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>,
Self: Sized,
Same as
join
, but with more futures.source§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>,
Self: Sized,
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>,
Self: Sized,
Same as
join
, but with more futures.source§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>,
Self: Sized,
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>,
Self: Sized,
Same as
join
, but with more futures.source§fn into_stream(self) -> IntoStream<Self>where
Self: Sized,
fn into_stream(self) -> IntoStream<Self>where
Self: Sized,
Convert this future into a single element stream. Read more
source§fn fuse(self) -> Fuse<Self>where
Self: Sized,
fn fuse(self) -> Fuse<Self>where
Self: Sized,
Fuse a future such that
poll
will never again be called once it has
completed. Read moresource§fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnOnce(&Self::Item),
Self: Sized,
fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnOnce(&Self::Item),
Self: Sized,
Do something with the item of a future, passing it on. Read more
Create a cloneable handle to this future where all handles will resolve
to the same result. Read more