Struct Cookie 

pub struct Cookie { /* private fields */ }

A cookie to send, or one that arrived.

Implementations

impl Cookie

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

A cookie with sensible defaults: path /, HttpOnly, SameSite=Lax.

Those defaults are the safe ones rather than the empty ones. A cookie this framework sets is a session or CSRF cookie until proven otherwise, and both want to be invisible to scripts and not sent cross-site. Opt out explicitly with http_only(false).

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

A cookie that instructs the browser to delete the named one.

pub fn name(&self) -> &str

The cookie’s name.

pub fn value(&self) -> &str

The cookie’s value.

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

Restrict the cookie to a path prefix.

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

Scope the cookie to a domain (and its subdomains).

pub fn max_age(self, seconds: i64) -> Self

Expire the cookie after seconds. 0 deletes it immediately.

pub fn expires(self, at: DateTime<Utc>) -> Self

Expire the cookie at an absolute time.

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

Only send the cookie over HTTPS.

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

Hide the cookie from JavaScript. On by default.

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

Set the cross-site policy.

SameSite::None also forces Secure, because every current browser rejects SameSite=None without it — silently, which would be a miserable thing to debug.

pub fn to_set_cookie(&self) -> String

Render the Set-Cookie header value.

Trait Implementations

impl Clone for Cookie

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 Cookie

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

Formats the value using the given formatter.

impl PartialEq for Cookie

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Cookie