Skip to main content

CookieName

Trait CookieName 

Source
pub trait CookieName {
    const NAME: &'static str;
}
Expand description

Trait for cookie name markers (similar to HeaderName).

Implement this trait to create a type-safe cookie extractor.

§Example

use fastapi_core::{CookieName, Cookie};

struct SessionId;
impl CookieName for SessionId {
    const NAME: &'static str = "session_id";
}

async fn get_session(Cookie(session): Cookie<String, SessionId>) -> impl IntoResponse {
    format!("Session: {}", session)
}

Required Associated Constants§

Source

const NAME: &'static str

The cookie name as it appears in the Cookie header.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl CookieName for CsrfToken

Source§

const NAME: &'static str = "csrf_token"

Source§

impl CookieName for CsrfTokenCookie

Source§

const NAME: &'static str = "csrf_token"

Source§

impl CookieName for SessionId

Source§

const NAME: &'static str = "session_id"