Struct poem::middleware::SetHeader

pub struct SetHeader { /* private fields */ }

Middleware for override/append headers to response.

Example

use poem::{
    get, handler,
    http::{HeaderValue, StatusCode},
    middleware::SetHeader,
    test::TestClient,
    Endpoint, EndpointExt, Request, Route,
};

#[handler]
fn index() -> &'static str {
    "hello"
}

let app = Route::new().at("/", get(index)).with(
    SetHeader::new()
        .appending("MyHeader1", "a")
        .appending("MyHeader1", "b")
        .overriding("MyHeader2", "a")
        .overriding("MyHeader2", "b"),
);

let resp = TestClient::new(app).get("/").send().await;
resp.assert_status_is_ok();
resp.assert_header_all("MyHeader1", ["a", "b"]);
resp.assert_header_all("MyHeader2", ["b"]);

Implementations

impl SetHeader

pub fn new() -> Self

Create new SetHeader middleware.

pub fn overriding<K, V>(self, key: K, value: V) -> Selfwhere
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,

Inserts a header to response.

If a previous value exists for the same header, it is removed and replaced with the new header value.

pub fn appending<K, V>(self, key: K, value: V) -> Selfwhere
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,

Appends a header to response.

If previous values exist, the header will have multiple values.

Trait Implementations

impl Default for SetHeader

fn default() -> SetHeader

Returns the “default value” for a type.

impl<E: Endpoint> Middleware<E> for SetHeader

type Output = SetHeaderEndpoint<E>

New endpoint type.

fn transform(&self, ep: E) -> Self::Output

Transform the input Endpoint to another one.