# Trait http_body::Body [−] [src]

###

###

    pub trait Body {
        type Data: Buf;
        type Error;
        fn poll_data(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>
        ) -> Poll<Option<Result<Self::Data, Self::Error>>>;
        fn poll_trailers(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>
        ) -> Poll<Result<Option<HeaderMap>, Self::Error>>;

        fn is_end_stream(&self) -> bool { ... }
        fn size_hint(&self) -> SizeHint { ... }
        fn data(&mut self) -> Data<'_, Self>ⓘNotable traits for Data<'a, T>impl<'a, T: Body + Unpin + ?Sized> Future for Data<'a, T>    type Output = Option<Result<T::Data, T::Error>>;
        where
            Self: Unpin + Sized,
        { ... }
        fn trailers(&mut self) -> Trailers<'_, Self>ⓘNotable traits for Trailers<'a, T>impl<'a, T: Body + Unpin + ?Sized> Future for Trailers<'a, T>    type Output = Result<Option<HeaderMap>, T::Error>;
        where
            Self: Unpin + Sized,
        { ... }
    }

Trait representing a streaming body of a Request or Response.

Data is streamed via the `poll_data` function, which asynchronously yields `T: Buf` values. The `size_hint` function provides insight into the total number of bytes that will be streamed.

The `poll_trailers` function returns an optional set of trailers used to finalize the request / response exchange. This is mostly used when using the HTTP/2.0 protocol.

## Associated Types

### `type Data: Buf` [src]

Values yielded by the `Body`.

### `type Error` [src]

The error type this `Body` might generate.

Loading content...

## Required methods

### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

Attempt to pull out the next data buffer of this stream.

### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

Poll for an optional single `HeaderMap` of trailers.

This function should only be called once `poll_data` returns `None`.

Loading content...

## Provided methods

### `fn is_end_stream(&self) -> bool` [src]

Returns `true` when the end of stream has been reached.

An end of stream means that both `poll_data` and `poll_trailers` will return `None`.

A return value of `false` does not guarantee that a value will be returned from `poll_stream` or `poll_trailers`.

### `fn size_hint(&self) -> SizeHint` [src]

Returns the bounds on the remaining length of the stream.

When the exact remaining length of the stream is known, the upper bound will be set and will equal the lower bound.

### `fn data(&mut self) -> Data<'_, Self>ⓘ

### Notable traits for Data<'a, T>

`impl<'a, T: Body + Unpin + ?Sized> Future for Data<'a, T> type Output = Option<Result<T::Data, T::Error>>;`
where
Self: Unpin + Sized,` [src]

Returns future that resolves to next data chunk, if any.

### `fn trailers(&mut self) -> Trailers<'_, Self>ⓘ

### Notable traits for Trailers<'a, T>

`impl<'a, T: Body + Unpin + ?Sized> Future for Trailers<'a, T> type Output = Result<Option<HeaderMap>, T::Error>;`
where
Self: Unpin + Sized,` [src]

Returns future that resolves to trailers, if any.

Loading content...

## Implementations on Foreign Types

### `impl<T: Body + Unpin + ?Sized> Body for &mut T` [src]

#### `type Data = T::Data`

#### `type Error = T::Error`

#### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

#### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

#### `fn is_end_stream(&self) -> bool` [src]

#### `fn size_hint(&self) -> SizeHint` [src]

### `impl<P> Body for Pin<P> where
P: Unpin + DerefMut,
P::Target: Body,` [src]

#### `type Data = <<P as Deref>::Target as Body>::Data`

#### `type Error = <<P as Deref>::Target as Body>::Error`

#### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

#### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

#### `fn is_end_stream(&self) -> bool` [src]

#### `fn size_hint(&self) -> SizeHint` [src]

### `impl<T: Body + Unpin + ?Sized> Body for Box<T>` [src]

#### `type Data = T::Data`

#### `type Error = T::Error`

#### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

#### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

#### `fn is_end_stream(&self) -> bool` [src]

#### `fn size_hint(&self) -> SizeHint` [src]

### `impl<B: Body> Body for Request<B>` [src]

#### `type Data = B::Data`

#### `type Error = B::Error`

#### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

#### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

#### `fn is_end_stream(&self) -> bool` [src]

#### `fn size_hint(&self) -> SizeHint` [src]

### `impl<B: Body> Body for Response<B>` [src]

#### `type Data = B::Data`

#### `type Error = B::Error`

#### `fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Data, Self::Error>>>` [src]

#### `fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap>, Self::Error>>` [src]

#### `fn is_end_stream(&self) -> bool` [src]

#### `fn size_hint(&self) -> SizeHint` [src]

Loading content...

## Implementors

Loading content...