# Struct hyper::Response [−] [src]

    pub struct Response<T> { /* fields omitted */ }

Represents an HTTP response

An HTTP response consists of a head and a potentially optional body. The body component is generic, enabling arbitrary types to represent the HTTP body. For example, the body could be `Vec<u8>`, a `Stream` of byte chunks, or a value that has been deserialized.

Typically you’ll work with responses on the client side as the result of sending a `Request` and on the server you’ll be generating a `Response` to send back to the client.

# Examples

Creating a `Response` to return

    use http::{Request, Response, StatusCode};

    fn respond_to(req: Request<()>) -> http::Result<Response<()>> {
        let mut builder = Response::builder()
            .header("Foo", "Bar")
            .status(StatusCode::OK);

        if req.headers().contains_key("Another-Header") {
            builder = builder.header("Another-Header", "Ack");
        }

        builder.body(())
    }

A simple 404 handler

    use http::{Request, Response, StatusCode};

    fn not_found(_req: Request<()>) -> http::Result<Response<()>> {
        Response::builder()
            .status(StatusCode::NOT_FOUND)
            .body(())
    }

Or otherwise inspecting the result of a request:

    use http::{Request, Response};

    fn get(url: &str) -> http::Result<Response<()>> {
        // ...
    }

    let response = get("https://www.rust-lang.org/").unwrap();

    if !response.status().is_success() {
        panic!("failed to get a successful response status!");
    }

    if let Some(date) = response.headers().get("Date") {
        // we've got a `Date` header!
    }

    let body = response.body();
    // ...

Deserialize a response of bytes via json:

    use http::Response;
    use serde::de;

    fn deserialize<T>(req: Response<Vec<u8>>) -> serde_json::Result<Response<T>>
        where for<'de> T: de::Deserialize<'de>,
    {
        let (parts, body) = req.into_parts();
        let body = serde_json::from_slice(&body)?;
        Ok(Response::from_parts(parts, body))
    }

Or alternatively, serialize the body of a response to json

    use http::Response;
    use serde::ser;

    fn serialize<T>(req: Response<T>) -> serde_json::Result<Response<Vec<u8>>>
        where T: ser::Serialize,
    {
        let (parts, body) = req.into_parts();
        let body = serde_json::to_vec(&body)?;
        Ok(Response::from_parts(parts, body))
    }

## Implementations

### `impl Response<()>` [src]

#### `pub fn builder() -> Builder` [src]

Creates a new builder-style object to manufacture a `Response`

This method returns an instance of `Builder` which can be used to create a `Response`.

# Examples

    let response = Response::builder()
        .status(200)
        .header("X-Custom-Foo", "Bar")
        .body(())
        .unwrap();

### `impl<T> Response<T>` [src]

#### `pub fn new(body: T) -> Response<T>` [src]

Creates a new blank `Response` with the body

The component ports of this response will be set to their default, e.g. the ok status, no headers, etc.

# Examples

    let response = Response::new("hello world");

    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(*response.body(), "hello world");

#### `pub fn from_parts(parts: Parts, body: T) -> Response<T>` [src]

Creates a new `Response` with the given head and body

# Examples

    let response = Response::new("hello world");
    let (mut parts, body) = response.into_parts();

    parts.status = StatusCode::BAD_REQUEST;
    let response = Response::from_parts(parts, body);

    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
    assert_eq!(*response.body(), "hello world");

#### `pub fn status(&self) -> StatusCode` [src]

Returns the `StatusCode`.

# Examples

    let response: Response<()> = Response::default();
    assert_eq!(response.status(), StatusCode::OK);

#### `pub fn status_mut(&mut self) -> &mut StatusCode` [src]

Returns a mutable reference to the associated `StatusCode`.

# Examples

    let mut response: Response<()> = Response::default();
    *response.status_mut() = StatusCode::CREATED;
    assert_eq!(response.status(), StatusCode::CREATED);

#### `pub fn version(&self) -> Version` [src]

Returns a reference to the associated version.

# Examples

    let response: Response<()> = Response::default();
    assert_eq!(response.version(), Version::HTTP_11);

#### `pub fn version_mut(&mut self) -> &mut Version` [src]

Returns a mutable reference to the associated version.

# Examples

    let mut response: Response<()> = Response::default();
    *response.version_mut() = Version::HTTP_2;
    assert_eq!(response.version(), Version::HTTP_2);

#### `pub fn headers(&self) -> &HeaderMap<HeaderValue>` [src]

Returns a reference to the associated header field map.

# Examples

    let response: Response<()> = Response::default();
    assert!(response.headers().is_empty());

#### `pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue>` [src]

Returns a mutable reference to the associated header field map.

# Examples

    let mut response: Response<()> = Response::default();
    response.headers_mut().insert(HOST, HeaderValue::from_static("world"));
    assert!(!response.headers().is_empty());

#### `pub fn extensions(&self) -> &Extensions` [src]

Returns a reference to the associated extensions.

# Examples

    let response: Response<()> = Response::default();
    assert!(response.extensions().get::<i32>().is_none());

#### `pub fn extensions_mut(&mut self) -> &mut Extensions` [src]

Returns a mutable reference to the associated extensions.

# Examples

    let mut response: Response<()> = Response::default();
    response.extensions_mut().insert("hello");
    assert_eq!(response.extensions().get(), Some(&"hello"));

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

Returns a reference to the associated HTTP body.

# Examples

    let response: Response<String> = Response::default();
    assert!(response.body().is_empty());

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

Returns a mutable reference to the associated HTTP body.

# Examples

    let mut response: Response<String> = Response::default();
    response.body_mut().push_str("hello world");
    assert!(!response.body().is_empty());

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

Consumes the response, returning just the body.

# Examples

    let response = Response::new(10);
    let body = response.into_body();
    assert_eq!(body, 10);

#### `pub fn into_parts(self) -> (Parts, T)` [src]

Consumes the response returning the head and body parts.

# Examples

    let response: Response<()> = Response::default();
    let (parts, body) = response.into_parts();
    assert_eq!(parts.status, StatusCode::OK);

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

Consumes the response returning a new response with body mapped to the return type of the passed in function.

# Examples

    let response = Response::builder().body("some string").unwrap();
    let mapped_response: Response<&[u8]> = response.map(|b| {
      assert_eq!(b, "some string");
      b.as_bytes()
    });
    assert_eq!(mapped_response.body(), &"some string".as_bytes());

## Trait Implementations

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

#### `type Data = <B as Body>::Data`

Values yielded by the `Body`.

#### `type Error = <B as Body>::Error`

The error type this `Body` might generate.

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

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

#### `pub fn poll_trailers(
self: Pin<&mut Response<B>>,
cx: &mut Context<'_>
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <Response<B> as Body>::Error>>` [src]

Poll for an optional single `HeaderMap` of trailers. Read more

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

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

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

Returns the bounds on the remaining length of the stream. Read more

#### `pub fn data(&mut self) -> Data<'_, Self> where
Self: Unpin,` [src]

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

#### `pub fn trailers(&mut self) -> Trailers<'_, Self> where
Self: Unpin,` [src]

Returns future that resolves to trailers, if any.

### `impl<T> Debug for Response<T> where
T: Debug,` [src]

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

Formats the value using the given formatter. Read more

### `impl<T> Default for Response<T> where
T: Default,` [src]

#### `pub fn default() -> Response<T>` [src]

Returns the “default value” for a type. Read more

## Auto Trait Implementations

### `impl<T> !RefUnwindSafe for Response<T>`

### `impl<T> Send for Response<T> where
T: Send,`

### `impl<T> Sync for Response<T> where
T: Sync,`

### `impl<T> Unpin for Response<T> where
T: Unpin,`

### `impl<T> !UnwindSafe for Response<T>`

## 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> 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<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<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.