Struct Cookies

pub struct Cookies { /* private fields */ }

A parsed on-demand cookie jar.

Implementations

impl Cookies

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

Adds Cookie to this jar. If a Cookie with the same name already exists, it is replaced with provided cookie.

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

Returns the Cookie with the given name. Returns None if it doesn’t exist.

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

Removes Cookie from this jar.

pub fn list(&self) -> Vec<Cookie<'_>>

Returns all the Cookies present in this jar.

This method collects Cookies into a vector instead of iterating through them to minimize the mutex locking time.

pub fn signed<'a>(&self, key: &'a Key) -> SignedCookies<'a>

Returns a child SignedCookies jar for interations with signed by the key cookies.

Example:

use cookie::{Cookie, Key};
use tower_cookies::Cookies;

let cookies = Cookies::default();
let key = Key::generate();
let signed = cookies.signed(&key);

let foo = Cookie::new("foo", "bar");
signed.add(foo.clone());

assert_eq!(signed.get("foo"), Some(foo.clone()));
assert_ne!(cookies.get("foo"), Some(foo));

pub fn private<'a>(&self, key: &'a Key) -> PrivateCookies<'a>

Returns a child PrivateCookies jar for encrypting and decrypting cookies.

Example:

use cookie::{Cookie, Key};
use tower_cookies::Cookies;

let cookies = Cookies::default();
let key = Key::generate();
let private = cookies.private(&key);

let foo = Cookie::new("foo", "bar");
private.add(foo.clone());

assert_eq!(private.get("foo"), Some(foo.clone()));
assert_ne!(cookies.get("foo"), Some(foo));

Trait Implementations

impl Clone for Cookies

fn clone(&self) -> Cookies

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cookies

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

Formats the value using the given formatter.

impl Default for Cookies

fn default() -> Cookies

Returns the “default value” for a type.

impl<S> FromRequestParts<S> for Cookies

where S: Sync + Send,

Available on crate feature axum-core only.

type Rejection = (StatusCode, &'static str)

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, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.