Skip to main content

CookiePolicy

Struct CookiePolicy 

Source
pub struct CookiePolicy { /* private fields */ }
Expand description

Policy governing cookie construction (RFC-006 §4).

Build with CookiePolicy::production_strict for the standard profile, or use the builder methods to customise. HttpOnly=true cannot be disabled (RFC-006 §13.2: “A production profile should reject Secure=false”).

Implementations§

Source§

impl CookiePolicy

Source

pub fn production_strict(name: impl Into<String>, max_age: Duration) -> Self

Standard production policy: HttpOnly; Secure; SameSite=Strict; Path=/. Domain is omitted to produce a host-only cookie (RFC-006 §5, implementation note: omitting Domain avoids subdomain leakage).

Source

pub fn production_lax(name: impl Into<String>, max_age: Duration) -> Self

Production policy with SameSite=Lax for cross-site top-level flows.

Source

pub fn local_development(name: impl Into<String>, max_age: Duration) -> Self

Development-only policy: Secure=false; SameSite=Lax. The caller must document why this is acceptable; it must not be used in production.

Source

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

Override Path. Defaults to /.

Source

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

Set an explicit Domain attribute. Pass None to produce a host-only cookie (the default and recommended choice).

Source

pub fn name(&self) -> &str

The configured cookie name.

Source

pub fn max_age_duration(&self) -> Duration

The configured max-age as a Duration.

Source

pub fn is_secure(&self) -> bool

Whether this policy requires the Secure attribute.

Build a Set-Cookie header value that delivers secret to the client.

secret must be the plaintext session or token secret — the only moment it crosses the wire. The caller must not log the returned string.

Build a Set-Cookie header value that clears this cookie (e.g. logout).

Uses Max-Age=0 with the same path/domain/name so browsers delete the existing cookie (RFC-006 §4 “clear cookie helper mirrors path/domain/name”).

Trait Implementations§

Source§

impl Clone for CookiePolicy

Source§

fn clone(&self) -> CookiePolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CookiePolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CookiePolicy

Source§

impl PartialEq for CookiePolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CookiePolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.