Struct axum_extra::extract::cookie::CookieJar

source ·

pub struct CookieJar { /* private fields */ }

Available on crate feature cookie only.

Expand description

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},
    response::{IntoResponse, Redirect},
    http::StatusCode,
};
use axum_extra::{
    TypedHeader,
    headers::authorization::{Authorization, Bearer},
    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§

source §

impl CookieJar

source

pub fn from_headers(headers: &HeaderMap) -> Self

Create a new CookieJar from a map of request headers.

The cookies in headers will be added to the jar.

This is intended to be used in middleware and other places where it might be difficult to run extractors. Normally you should create CookieJars through FromRequestParts.

source

pub fn new() -> Self

Create a new empty CookieJar.

This is intended to be used in middleware and other places where it might be difficult to run extractors. Normally you should create CookieJars through FromRequestParts.

If you need a jar that contains the headers from a request use impl From<&HeaderMap> for CookieJar.

source

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());
}

source

pub fn remove<C: Into<Cookie<'static>>>(self, cookie: C) -> 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::from("foo"))
}

source

pub fn add<C: Into<Cookie<'static>>>(self, cookie: C) -> 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"))
}

source