Struct poem::web::TypedHeader

pub struct TypedHeader<T>(pub T);

An extractor that extracts a typed header value.

Errors

• ParseTypedHeaderError

Example

use poem::{
    get, handler,
    http::{header, StatusCode},
    test::TestClient,
    web::{headers::Host, TypedHeader},
    Endpoint, Request, Route,
};

#[handler]
fn index(TypedHeader(host): TypedHeader<Host>) -> String {
    host.hostname().to_string()
}

let app = Route::new().at("/", get(index));
let cli = TestClient::new(app);

let resp = cli
    .get("/")
    .header(header::HOST, "example.com")
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("example.com").await;

Tuple Fields

0: T

Trait Implementations

impl<T: Debug> Debug for TypedHeader<T>

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

Formats the value using the given formatter.

impl<T> Deref for TypedHeader<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for TypedHeader<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: Header> FromRequest<'a> for TypedHeader<T>

fn from_request<'life0, 'async_trait>(
    req: &'a Request,
    _body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Extract from request head and body.

fn from_request_without_body<'async_trait>(
    req: &'a Request
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Send + 'async_trait, 

Extract from request head.