[][src]Struct rusoto_core::RusotoFuture

pub struct RusotoFuture<T, E> { /* fields omitted */ }

Future that is returned from all rusoto service APIs.

Mocking

To mock service traits, you can use [RusotoFuture::from_future] to create [RusotoFuture] instance. You can also use the [From] implementation on the [Result] value.

This example is not tested
use std::time::{Duration, Instant};
use futures::prelude::*;
use rusoto_core::RusotoFuture;
use rusoto_s3::*;
use tokio_timer::Delay;

pub struct S3Mock;

impl S3 for S3Mock {
    fn abort_multipart_upload(
        &self,
        _input: AbortMultipartUploadRequest,
    ) -> RusotoFuture<AbortMultipartUploadOutput, AbortMultipartUploadError> {
        unimplemented!();
    }

    // ...

    fn put_object(&self, input: PutObjectRequest) -> RusotoFuture<PutObjectOutput, PutObjectError> {
        if input.bucket == "foo" {
            let deadline = Instant::now() + Duration::from_secs(3);
            let output = PutObjectOutput {
                ..Default::default()
            };
            RusotoFuture::from_future(
                Delay::new(deadline)
                    .map_err(|e| PutObjectError::Unknown(e.to_string()))
                    .map(|_| output)
            )
        } else {
            Err(PutObjectError::Validation("Invalid bucket".to_string())).into()
        }
    }

    // ...
}

Methods

impl<T, E> RusotoFuture<T, E>[src]

pub fn with_timeout(self, timeout: Duration) -> Self[src]

Set the timeout on the future to the provided duration.

Unlike set_timeout this method can be easily chained:

This example is not tested
let future = s3.list_buckets()
    .with_timeout(Duration::from_secs(10));

This is only guaranteed to take effect when called before the future is polled for the first time.

pub fn set_timeout(&mut self, timeout: Duration)[src]

Set the timeout on the future to the provided duration.

This is only guaranteed to take effect when called before the future is polled for the first time.

pub fn clear_timeout(&mut self)[src]

Clear the timeout on the future.

This is only guaranteed to take effect when called before the future is polled for the first time.

pub fn sync(self) -> RusotoResult<T, E> where
    T: Send + 'static,
    E: Send + 'static, 
[src]

Blocks the current thread until the future has resolved.

This is meant to provide a simple way for non-async consumers to work with rusoto.

pub fn from_future<F>(fut: F) -> Self where
    F: IntoFuture<Item = T, Error = RusotoError<E>>,
    F::Future: Send + 'static, 
[src]

Wraps the provided future, mainly to mock the service response.

Caution

This is not intended to be used outside of the test case. In production, [Box] is recommended.

Trait Implementations

impl<T: Send + 'static, E: Send + 'static> From<Result<T, RusotoError<E>>> for RusotoFuture<T, E>[src]

impl<T, E> Future for RusotoFuture<T, E>[src]

type Item = T

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

type Error = RusotoError<E>

The type of error that this future will resolve with if it fails in a normal fashion. 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<T, E> Send for RusotoFuture<T, E>

impl<T, E> !Sync for RusotoFuture<T, E>

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]

type Error = !

🔬 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> 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

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

The type returned in the event of a conversion error.

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

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

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

fn timeout(self, timeout: Duration) -> Timeout<Self>[src]

Creates a new future which allows self until timeout. Read more

impl<T> Same for T

type Output = T

Should always be Self