Struct CookieStore

#[non_exhaustive]
pub struct CookieStore {
    pub max_age: Duration,
    pub same_site: SameSite,
    pub http_only: bool,
    pub path: String,
    pub name: String,
}

Available on crate feature cookie-store only.

CookieStore is a FlashStore implementation that stores the flash messages in a cookie.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_age: Duration

The cookie max age.

same_site: SameSite

The cookie same site.

http_only: bool

The cookie http only.

path: String

The cookie path.

name: String

The cookie name.

Implementations

impl CookieStore

pub fn new() -> Self

Create a new CookieStore.

pub fn name(self, name: impl Into<String>) -> Self

Sets cookie name.

pub fn max_age(self, max_age: Duration) -> Self

Sets cookie max_age.

pub fn same_site(self, same_site: SameSite) -> Self

Sets cookie same site.

pub fn http_only(self, http_only: bool) -> Self

Sets cookie http only.

pub fn path(self, path: impl Into<String>) -> Self

Sets cookie path.

pub fn into_handler(self) -> FlashHandler<CookieStore>

Into FlashHandler.

Trait Implementations

impl Debug for CookieStore

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

Formats the value using the given formatter.

impl Default for CookieStore

fn default() -> Self

Returns the “default value” for a type.

impl FlashStore for CookieStore

async fn load_flash( &self, req: &mut Request, _depot: &mut Depot, ) -> Option<Flash>

Get the flash messages from the store.

async fn save_flash( &self, _req: &mut Request, _depot: &mut Depot, res: &mut Response, flash: Flash, )

Save the flash messages to the store.

async fn clear_flash(&self, _depot: &mut Depot, res: &mut Response)

Clear the flash store.