Struct CookieConfig 

pub struct CookieConfig { /* private fields */ }

Session cookie attributes.

The defaults are the safest option for a same-origin app:

Set-Cookie: __Host-sid=<43 chars>; Path=/; Max-Age=2592000; HttpOnly; Secure; SameSite=Lax

Browsers enforce the __Host- prefix: the cookie must be Secure, have Path=/ and no Domain, so a sibling subdomain cannot set or overwrite it. CookieConfig::validate (run by GuardConfig’s build) rejects combinations browsers would drop.

Implementations

impl CookieConfig

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

Defaults with a different cookie name.

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

Cookie name. Keep the __Host- prefix unless you need Domain or a narrower Path.

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

Path attribute (default /).

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

Domain attribute (default none, i.e. host-only). Not allowed with __Host-.

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

Secure attribute (default on). Only turn this off for plain-HTTP local development, and then also drop the __Host- prefix.

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

HttpOnly attribute (default on), which hides the token from JavaScript.

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

SameSite attribute (default Lax).

pub const fn persistent(self, persistent: bool) -> Self

Whether the cookie carries Max-Age (default on). When off, it is a browser-session cookie that disappears when the browser closes; server-side expiry still applies.

pub fn cookie_name(&self) -> &str

The cookie name.

pub fn validate(&self) -> Result<(), ConfigError>

Checks the attributes against what browsers accept.

Errors

ConfigError::InvalidCookie describing the first problem found.

pub fn set_cookie(&self, token: &str, max_age_secs: i64) -> String

Renders a Set-Cookie value carrying token. max_age_secs is clamped at zero and only emitted for persistent cookies.

pub fn clear_cookie(&self) -> String

Renders a Set-Cookie value that deletes the cookie.

pub fn find_in<'a>(&self, cookie_header: &'a str) -> Option<&'a str>

Finds this cookie’s value in one Cookie header value. Takes the first occurrence (the browser sends the most specific path first). Returns the raw value, unvalidated.

Trait Implementations

impl Clone for CookieConfig

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 CookieConfig

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

Formats the value using the given formatter.

impl Default for CookieConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CookieConfig

impl PartialEq for CookieConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CookieConfig