Struct CookieJar 

pub struct CookieJar { /* private fields */ }

A generic CookieJar for cookie management. Can be used to read update or delete cookies from a user session.

axum feature

Note that to set the cookies, the jar must be returned from the handler. Otherwise the cookies are not updated.

Example

use cookie_monster::{CookieJar, Cookie};

static COOKIE_NAME: &str = "session";

async fn handler(mut jar: CookieJar) -> CookieJar {

    if let Some(cookie) = jar.get(COOKIE_NAME) {
        println!("Removing cookie {cookie:?}");
        jar.remove(Cookie::named(COOKIE_NAME));
    } else {
        let cookie = Cookie::new(COOKIE_NAME, "hello, world");
        println!("Setting cookie {cookie:?}");
        jar.add(cookie);
    }

    // Important, return the jar to update the cookies!
    jar
}

Implementations

impl CookieJar

pub fn empty() -> Self

Creates an empty CookieJar.

pub fn from_cookie(header: &str) -> Self

Parses the given cookie header value and return a CookieJar. This function ignores cookies that were not able to be parsed.

pub fn from_encoded_cookie(header: &str) -> Self

Parses the given cookie header value and return a CookieJar. The cookie name and values are percent-decoded. Cookies that were not able to be parsed are ignored.

pub fn add_original(&mut self, cookie: Cookie)

Adds an original cookie to the jar. These are never sent back to the user-agent, but are visible in the cookie jar.

pub fn from_original<T: IntoIterator<Item = Cookie>>(cookies: T) -> Self

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

Get a cookie by name. Gives back either an original or newly added cookie.

pub fn set_cookie_headers(&self) -> impl Iterator<Item = Result<String, Error>>

Iterate over all changes. This returns all removed and newly created cookies.

pub fn remove(&mut self, cookie: impl Into<Cookie>)

Removes the cookie from the local cookie store and issues a cookie with an Expires attribute in the past and Max-Age of 0 seconds.

If one of the time, chrono or jiff features are enabled, the Expires tag is set to the current time minus one year. If none of the those features are enabled, the Expires attribute is set to 1 Jan 1970 00:00.

To ensure a cookie is removed from the user-agent, set the Path and Domain attributes with the same values that were used to create the cookie.

pub fn add(&mut self, cookie: impl Into<Cookie>)

Adds a cookie to the jar. If a cookie with the same name is already in the jar, it is replaced with the given cookie.

impl CookieJar

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

pub fn write_cookies(self, headers: &mut HeaderMap)

Trait Implementations

impl Debug for CookieJar

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

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 = 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.

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Self, Self::Rejection>

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