Struct axum::response::Headers

pub struct Headers<H>(pub H);

A response with headers.

Example

use axum::{
    Router,
    response::{IntoResponse, Headers},
    routing::get,
};
use http::header::{HeaderName, HeaderValue};

// It works with any `IntoIterator<Item = (Key, Value)>` where `Key` can be
// turned into a `HeaderName` and `Value` can be turned into a `HeaderValue`
//
// Such as `Vec<(HeaderName, HeaderValue)>`
async fn just_headers() -> impl IntoResponse {
    Headers(vec![
        (HeaderName::from_static("X-Foo"), HeaderValue::from_static("foo")),
    ])
}

// Or `Vec<(&str, &str)>`
async fn from_strings() -> impl IntoResponse {
    Headers(vec![("X-Foo", "foo")])
}

// Or `[(&str, &str)]` if you're on Rust 1.53+

let app = Router::new()
    .route("/just-headers", get(just_headers))
    .route("/from-strings", get(from_strings));

If a conversion to HeaderName or HeaderValue fails a 500 Internal Server Error response will be returned.

You can also return (Headers, impl IntoResponse) to customize the headers of a response, or (StatusCode, Headeres, impl IntoResponse) to customize the status code and headers.

Tuple Fields

0: H

Trait Implementations

impl<H> Clone for Headers<H> where
    H: Clone, 

pub fn clone(&self) -> Headers<H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H> Debug for Headers<H> where
    H: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<H, K, V> IntoResponse for Headers<H> where
    H: IntoIterator<Item = (K, V)>,
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,
    <K as TryInto<HeaderName>>::Error: Display,
    <V as TryInto<HeaderValue>>::Error: Display, 

pub fn into_response(self) -> Response<UnsyncBoxBody<Bytes, Error>>

Create a response.

impl<H> Copy for Headers<H> where
    H: Copy,