Struct poem::session::CookieConfig

pub struct CookieConfig { /* private fields */ }

This is supported on crate feature session only.

Cookie configuration for session.

Implementations

impl CookieConfig

pub fn new() -> Self

Create a new plain CookieSession.

pub fn private(key: CookieKey) -> Self

Create a new private CookieSession.

pub fn signed(key: CookieKey) -> Self

Create a new signed CookieSession.

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

Sets the name to the session cookie.

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

Sets the Path to the session cookie. Default is /.

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

Sets the Domain to the session cookie.

pub fn secure(self, value: bool) -> Self

Sets the Secure to the session cookie. Default is true.

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

Sets the HttpOnly to the session cookie. Default is true.

pub fn same_site(self, value: impl Into<Option<SameSite>>) -> Self

Sets the SameSite to the session cookie.

pub fn max_age(self, value: impl Into<Option<Duration>>) -> Self

Sets the MaxAge to the session cookie.

pub fn set_cookie_value(&self, cookie_jar: &CookieJar, value: &str)

Set the cookie value to CookieJar.

pub fn remove_cookie(&self, cookie_jar: &CookieJar)

Remove the cookie from CookieJar.

pub fn get_cookie_value(&self, cookie_jar: &CookieJar) -> Option<String>

Gets the cookie value from CookieJar.

Trait Implementations

impl Default for CookieConfig

fn default() -> Self

Returns the “default value” for a type.