Struct axum_extra::extract::cookie::CookieJar

pub struct CookieJar { /* private fields */ }

Available on crate feature cookie only.

Extractor that grabs cookies from the request and manages the jar.

Note that methods like CookieJar::add, CookieJar::remove, etc updates the CookieJar and returns it. This value must be returned from the handler as part of the response for the changes to be propagated.

Example

use axum::{
    Router,
    routing::{post, get},
    extract::TypedHeader,
    response::{IntoResponse, Redirect},
    headers::authorization::{Authorization, Bearer},
    http::StatusCode,
};
use axum_extra::extract::cookie::{CookieJar, Cookie};

async fn create_session(
    TypedHeader(auth): TypedHeader<Authorization<Bearer>>,
    jar: CookieJar,
) -> Result<(CookieJar, Redirect), StatusCode> {
    if let Some(session_id) = authorize_and_create_session(auth.token()).await {
        Ok((
            // the updated jar must be returned for the changes
            // to be included in the response
            jar.add(Cookie::new("session_id", session_id)),
            Redirect::to("/me"),
        ))
    } else {
        Err(StatusCode::UNAUTHORIZED)
    }
}

async fn me(jar: CookieJar) -> Result<(), StatusCode> {
    if let Some(session_id) = jar.get("session_id") {
        // fetch and render user...
    } else {
        Err(StatusCode::UNAUTHORIZED)
    }
}

async fn authorize_and_create_session(token: &str) -> Option<String> {
    // authorize the user and create a session...
}

let app = Router::new()
    .route("/sessions", post(create_session))
    .route("/me", get(me));

Implementations

impl CookieJar

pub fn get(&self, name: &str) -> Option<&Cookie<'static>>

Get a cookie from the jar.

Example

use axum_extra::extract::cookie::CookieJar;
use axum::response::IntoResponse;

async fn handle(jar: CookieJar) {
    let value: Option<String> = jar
        .get("foo")
        .map(|cookie| cookie.value().to_owned());
}

pub fn remove(self, cookie: Cookie<'static>) -> Self

Remove a cookie from the jar.

Example

use axum_extra::extract::cookie::{CookieJar, Cookie};
use axum::response::IntoResponse;

async fn handle(jar: CookieJar) -> CookieJar {
    jar.remove(Cookie::named("foo"))
}

pub fn add(self, cookie: Cookie<'static>) -> Self

Add a cookie to the jar.

The value will automatically be percent-encoded.

Example

use axum_extra::extract::cookie::{CookieJar, Cookie};
use axum::response::IntoResponse;

async fn handle(jar: CookieJar) -> CookieJar {
    jar.add(Cookie::new("foo", "bar"))
}

pub fn iter(&self) -> impl Iterator<Item = &Cookie<'static>>

Get an iterator over all cookies in the jar.

Trait Implementations

impl Debug for CookieJar

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

Formats the value using the given formatter.

impl<B> FromRequest<B> for CookieJar where
    B: Send, 

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>(
    req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform the extraction.

impl IntoResponse for CookieJar

fn into_response(self) -> Response

Create a response.

impl IntoResponseParts for CookieJar

type Error = Infallible

The type returned in the event of an error.

fn into_response_parts(
    self,
    res: ResponseParts
) -> Result<ResponseParts, Self::Error>

Set parts of the response