Struct CookieJar 

pub struct CookieJar { /* private fields */ }

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

impl CookieJar

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

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.

pub fn new() -> CookieJar

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.

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<C>(self, cookie: C) -> CookieJar

where C: Into<Cookie<'static>>,

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"))
}

pub fn add<C>(self, cookie: C) -> CookieJar

where C: Into<Cookie<'static>>,

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 Clone for CookieJar

fn clone(&self) -> CookieJar

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CookieJar

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

Formats the value using the given formatter.

impl Default for CookieJar

fn default() -> CookieJar

Returns the “default value” for a type.

impl<S> FromRequestParts<S> for CookieJar

where S: Send + Sync,

type Rejection = !

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_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<CookieJar, <CookieJar as FromRequestParts<S>>::Rejection>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, CookieJar: 'async_trait,

Perform the extraction.

impl IntoResponse for CookieJar

fn into_response(self) -> Response<Body>

Create a response.

impl IntoResponseParts for CookieJar

type Error = !

The type returned in the event of an error.

fn into_response_parts( self, res: ResponseParts, ) -> Result<ResponseParts, <CookieJar as IntoResponseParts>::Error>

Set parts of the response