Enum aws_smithy_client::timeout::TimeoutServiceFuture

#[non_exhaustive]
pub enum TimeoutServiceFuture<F> {
    Timeout {
        future: Timeout<F, Sleep>,
        kind: &'static str,
        duration: Duration,
    },
    NoTimeout {
        future: F,
    },
}

A future generated by a TimeoutService that may or may not have a timeout depending on whether or not one was set. Because TimeoutService can be used at multiple levels of the service stack, a kind can be set so that when a timeout occurs, you can know which kind of timeout it was.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Timeout

Fields

future: Timeout<F, Sleep>

kind: &'static str

duration: Duration

A wrapper around an inner future that will output an SdkError if it runs longer than the given duration

NoTimeout

Fields

future: F

A thin wrapper around an inner future that will never time out

Implementations

impl<F> TimeoutServiceFuture<F>

pub fn new(future: F, params: &TimeoutServiceParams) -> Self

Given a future, an implementor of AsyncSleep, a kind for this timeout, and a duration, wrap the future inside a Timeout future and create a new TimeoutServiceFuture that will output an SdkError if future doesn’t complete before duration has elapsed.

pub fn no_timeout(future: F) -> Self

Create a TimeoutServiceFuture that will never time out.

Trait Implementations

impl<InnerFuture, T, E> Future for TimeoutServiceFuture<InnerFuture>where InnerFuture: Future<Output = Result<T, SdkError<E>>>,

type Output = Result<T, SdkError<E>>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'__pin, F> Unpin for TimeoutServiceFuture<F>where __Origin<'__pin, F>: Unpin,