Enum actix_web::cookie::SameSite

pub enum SameSite {
    Strict,
    Lax,
    None,
}

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 not present then the cookie will be sent as normal. In some browsers, this will implicitly handle the cookie as if "Lax" and in others, "None". It's best to explicitly set the SameSite attribute to avoid inconsistent behavior.

Note: Depending on browser, the Secure attribute may be required for SameSite "None" cookies to be accepted.

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

More info about these draft changes can be found in the draft spec:

• https://tools.ietf.org/html/draft-west-cookie-incrementalism-00

Variants

Strict

The "Strict" SameSite attribute.

Lax

The "Lax" SameSite attribute.

None

The "None" SameSite attribute.

Methods

impl SameSite

pub fn is_strict(self) -> bool

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

Example

use actix_http::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 actix_http::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 actix_http::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 Copy for SameSite

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 Eq for SameSite

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<SameSite> for SameSite

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for SameSite

impl StructuralPartialEq for SameSite