Struct SignedJar 

pub struct SignedJar<'key, J> { /* private fields */ }

A Cookies adapter that signs cookies written through it and verifies cookies read through it, using a Key.

Signing detects changes to a cookie’s value while leaving it readable by the client. Create a signed jar with Cookies::signed or signed_cookies.

Reads return None for missing cookies or invalid signatures. This adapter can be combined with prefixes and attribute defaults.

Trait Implementations

impl<'key, J: Clone> Clone for SignedJar<'key, J>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<J: Cookies> Cookies for SignedJar<'_, J>

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

Returns the cookie named name, or None if it is absent (or, for signed/encrypted jars, fails to verify).

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

Adds cookie. It is serialized into a Set-Cookie response header once the cookie router layer handles the response.

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

Removes cookie. If the request carried an original cookie with the same name, an expiring removal cookie is sent. Pass the same Path/ Domain the cookie was set with.

fn signed(self, key: &Key) -> SignedJar<'_, Self>

where Self: Sized,

Wraps this jar so signed cookies are written and verified with key.

fn private(self, key: &Key) -> PrivateJar<'_, Self>

where Self: Sized,

Wraps this jar so cookies are encrypted and decrypted with key.

fn map<F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: Fn(&mut Cookie<'static>),

Wraps this jar so every added cookie is passed through f before being stored. Use this for custom attribute changes.

fn override_prefix_host(self) -> Prefixed<Self>

where Self: Sized,

Forces the __Host- prefix and its required attributes (Secure, Path=/, no Domain) on every added cookie.

fn default_prefix_host(self) -> Prefixed<Self>

where Self: Sized,

Applies the __Host- prefix, filling its required attributes only when the cookie does not already set them.

fn override_prefix_secure(self) -> Prefixed<Self>

where Self: Sized,

Forces the __Secure- prefix and its required Secure attribute on every added cookie.

fn default_prefix_secure(self) -> Prefixed<Self>

where Self: Sized,

Applies the __Secure- prefix, setting Secure only when the cookie does not already set it.

fn override_secure( self, value: bool, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Secure on every added cookie, overriding any existing value.

fn default_secure(self, value: bool) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Secure on added cookies that do not already specify it.

fn override_http_only( self, value: bool, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets HttpOnly on every added cookie, overriding any existing value.

fn default_http_only( self, value: bool, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets HttpOnly on added cookies that do not already specify it.

fn override_same_site( self, value: SameSite, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets SameSite on every added cookie, overriding any existing value.

fn default_same_site( self, value: SameSite, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets SameSite on added cookies that do not already specify it.

fn override_path( self, value: impl Into<String>, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Path on every added cookie, overriding any existing value.

fn default_path( self, value: impl Into<String>, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Path on added cookies that do not already specify it.

fn override_domain( self, value: impl Into<String>, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Domain on every added cookie, overriding any existing value.

fn default_domain( self, value: impl Into<String>, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Domain on added cookies that do not already specify it.

fn override_max_age( self, value: Duration, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Max-Age on every added cookie, overriding any existing value.

fn default_max_age( self, value: Duration, ) -> Map<Self, impl Fn(&mut Cookie<'static>)>

where Self: Sized,

Sets Max-Age on added cookies that do not already specify it.

impl<'key, J: Copy> Copy for SignedJar<'key, J>

impl<'key, J: Debug> Debug for SignedJar<'key, J>

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

Formats the value using the given formatter.