Enum SameSite

pub enum SameSite {
    Strict,
    Lax,
    None,
}

Available on crate feature cookie only.

The SameSite cookie attribute.

A cookie with a SameSite attribute is imposed restrictions on when it is sent to the origin server in a cross-site request. If the SameSite attribute is “Strict”, then the cookie is never sent in cross-site requests. If the SameSite attribute is “Lax”, the cookie is only sent in cross-site requests with “safe” HTTP methods, i.e, GET, HEAD, OPTIONS, TRACE. If the SameSite attribute is “None”, the cookie is sent in all cross-site requests if the “Secure” flag is also set, otherwise the cookie is ignored. This library automatically sets the “Secure” flag on cookies when same_site is set to SameSite::None as long as secure is not explicitly set to false.

If the SameSite attribute is not present (by not setting SameSite initally or passing None to Cookie::set_same_site()), then the cookie will be sent as normal.

Note: This cookie attribute is an HTTP draft! Its meaning and definition are subject to change.

Variants

Strict

The “Strict” SameSite attribute.

Lax

The “Lax” SameSite attribute.

None

The “None” SameSite attribute.

Implementations

impl SameSite

pub fn is_strict(&self) -> bool

Returns true if self is SameSite::Strict and false otherwise.

Example

use cookie::SameSite;

let strict = SameSite::Strict;
assert!(strict.is_strict());
assert!(!strict.is_lax());
assert!(!strict.is_none());

pub fn is_lax(&self) -> bool

Returns true if self is SameSite::Lax and false otherwise.

Example

use cookie::SameSite;

let lax = SameSite::Lax;
assert!(lax.is_lax());
assert!(!lax.is_strict());
assert!(!lax.is_none());

pub fn is_none(&self) -> bool

Returns true if self is SameSite::None and false otherwise.

Example

use cookie::SameSite;

let none = SameSite::None;
assert!(none.is_none());
assert!(!none.is_lax());
assert!(!none.is_strict());

Trait Implementations

impl Clone for SameSite

fn clone(&self) -> SameSite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SameSite

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

Formats the value using the given formatter.

impl Display for SameSite

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

Formats the value using the given formatter.

impl Hash for SameSite

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SameSite

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SameSite

impl Eq for SameSite

impl StructuralPartialEq for SameSite