# Struct h2::client::ResponseFuture [−] [src]

    #[must_use = "futures do nothing unless polled"]pub struct ResponseFuture { /* fields omitted */ }

A future of an HTTP response.

## Implementations

### `impl ResponseFuture` [src]

#### `pub fn stream_id(&self) -> StreamId` [src]

Returns the stream ID of the response stream.

# Panics

If the lock on the stream store has been poisoned.

#### `pub fn push_promises(&mut self) -> PushPromises` [src]

Returns a stream of PushPromises

# Panics

If this method has been called before or the stream was itself was pushed

## Trait Implementations

### `impl Debug for ResponseFuture` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Future for ResponseFuture` [src]

#### `type Output = Result<Response<RecvStream>, Error>`

The type of value produced on completion.

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

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

## Auto Trait Implementations

### `impl RefUnwindSafe for ResponseFuture`

### `impl Send for ResponseFuture`

### `impl Sync for ResponseFuture`

### `impl Unpin for ResponseFuture`

### `impl UnwindSafe for ResponseFuture`

## Blanket Implementations

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

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

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

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

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

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

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

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

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

#### `pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,` [src]

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

#### `pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,` [src]

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

#### `pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,` [src]

Wrap this future in an `Either` future, making it the left-hand variant of that `Either`. Read more

#### `pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,` [src]

Wrap this future in an `Either` future, making it the right-hand variant of that `Either`. Read more

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

Convert this future into a single element stream. Read more

#### `pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future,` [src]

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

#### `pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,` [src]

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

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

Fuse a future such that `poll` will never again be called once it has completed. This method can be used to turn any `Future` into a `FusedFuture`. Read more

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

Do something with the output of a future before passing it on. Read more

#### `pub fn unit_error(self) -> UnitError<Self>` [src]

Turns a `Future<Output = T>` into a `TryFuture<Ok = T, Error = ()`>. Read more

#### `pub fn never_error(self) -> NeverError<Self>` [src]

Turns a `Future<Output = T>` into a `TryFuture<Ok = T, Error = Never`>. Read more

#### `pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,` [src]

A convenience for calling `Future::poll` on `Unpin` future types.

#### `pub fn now_or_never(self) -> Option<Self::Output>` [src]

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to `Future::poll`. Read more

### `impl<T> Instrument for T` [src]

#### `pub fn instrument(self, span: Span) -> Instrumented<Self>` [src]

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more

#### `pub fn in_current_span(self) -> Instrumented<Self>` [src]

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more

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

#### `pub fn into(self) -> U` [src]

Performs the conversion.

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

#### `type Output = <F as Future>::Output`

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

The output that the future will produce on completion.

#### `type Future = F`

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

Which kind of future are we turning this into?

#### `pub fn into_future(self) -> <F as IntoFuture>::Future` [src]

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

Creates a future from a value.

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

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,` [src]

#### `type Ok = T`

The type of successful values yielded by this future

#### `type Error = E`

The type of failures yielded by this future

#### `pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>` [src]

Poll this `TryFuture` as if it were a `Future`. Read more

### `impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,` [src]

#### `pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,` [src]

Maps this future’s success value to a different value. Read more

#### `pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,` [src]

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

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

Maps this future’s error value to a different value. Read more

#### `pub fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>,` [src]

Maps this future’s `Error` to a new error type using the `Into` trait. Read more

#### `pub fn ok_into<U>(self) -> OkInto<Self, U> where
Self::Ok: Into<U>,` [src]

Maps this future’s `Ok` to a new type using the `Into` trait. Read more

#### `pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,` [src]

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

#### `pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,` [src]

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

#### `pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),` [src]

Do something with the success value of a future before passing it on. Read more

#### `pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),` [src]

Do something with the error value of a future before passing it on. Read more

#### `pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,` [src]

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

#### `pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,` [src]

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

#### `pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,` [src]

Unwraps this future’s output, producing a future with this future’s `Ok` type as its `Output` type. Read more

#### `pub fn into_future(self) -> IntoFuture<Self>` [src]

Wraps a `TryFuture` into a type that implements `Future`. Read more

#### `pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,` [src]

A convenience method for calling `TryFuture::try_poll` on `Unpin` future types. Read more

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

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.