Struct Cookies 

pub struct Cookies { /* private fields */ }

Available on crate feature cookie only.

Extracts the cookies from the request.

Implementations

impl Cookies

pub fn new(cookie_jar: CookieJar) -> Self

Creates a new Cookies with the CookieJar.

pub fn jar(&self) -> &Mutex<CookieJar>

Retures the inner mutex CookieJar.

pub fn remove(&self, name: impl AsRef<str>)

Removes cookie from this cookies.

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

Returns a Cookie inside this cookies with the name.

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

Adds cookie to this cookies.

pub fn add_original(&self, cookie: Cookie<'_>)

Adds an “original” cookie to this cookies.

pub fn reset_delta(&self)

Removes all delta cookies.

impl Cookies

pub fn with_key(self, key: Arc<CookieKey>) -> Self

Available on crate features cookie-signed or cookie-private only.

A cryptographic master key for use with Signed and/or Private jars.

pub fn key(&self) -> &CookieKey

Available on crate features cookie-signed or cookie-private only.

Retures the cryptographic master Key.

Panics

Will panic if missing a key

impl Cookies

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

Available on crate feature cookie-private only.

Returns a reference to the Cookie inside this jar with the specified name.

pub fn private_add(&self, cookie: Cookie<'_>)

Available on crate feature cookie-private only.

Adds cookie to the parent jar.

pub fn private_remove(&self, name: impl AsRef<str>)

Available on crate feature cookie-private only.

Removes cookie from the parent jar.

pub fn private_add_original(&self, cookie: Cookie<'_>)

Available on crate feature cookie-private only.

Adds an “original” cookie to parent jar.

pub fn private_decrypt(&self, cookie: Cookie<'_>) -> Option<Cookie<'_>>

Available on crate feature cookie-private only.

Authenticates and decrypts cookie and returning the plain cookie.

impl Cookies

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

Available on crate feature cookie-signed only.

Returns a reference to the Cookie inside this jar with the specified name.

pub fn signed_add(&self, cookie: Cookie<'_>)

Available on crate feature cookie-signed only.

Adds cookie to the parent jar.

pub fn signed_remove(&self, name: impl AsRef<str>)

Available on crate feature cookie-signed only.

Removes cookie from the parent jar.

pub fn signed_add_original(&self, cookie: Cookie<'_>)

Available on crate feature cookie-signed only.

Adds an “original” cookie to parent jar.

pub fn signed_verify(&self, cookie: Cookie<'_>) -> Option<Cookie<'_>>

Available on crate feature cookie-signed only.

Verifies the authenticity and integrity of cookie and returning the plain cookie.

Trait Implementations

impl Clone for Cookies

fn clone(&self) -> Self

Returns a duplicate 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 FromRequest for Cookies

type Error = CookiesError

The type returned in the event of a conversion error.

async fn extract(req: &mut Request) -> Result<Self, Self::Error>

Extracts this type from the HTTP Request.