mirror of
https://github.com/actix/actix-web.git
synced 2024-06-11 09:49:29 +00:00
8888520d83
* add benchmark for full stack request lifecycle * add direct service benchmarks * fix newline * add cloneable service benchmarks * remove cloneable bench experiments + cargo fmt Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
107 lines
3.2 KiB
Rust
107 lines
3.2 KiB
Rust
//! This module contains types that represent cookie properties that are not yet
|
|
//! standardized. That is, _draft_ features.
|
|
|
|
use std::fmt;
|
|
|
|
/// 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
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
|
pub enum SameSite {
|
|
/// The "Strict" `SameSite` attribute.
|
|
Strict,
|
|
/// The "Lax" `SameSite` attribute.
|
|
Lax,
|
|
/// The "None" `SameSite` attribute.
|
|
None,
|
|
}
|
|
|
|
impl SameSite {
|
|
/// Returns `true` if `self` is `SameSite::Strict` and `false` otherwise.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// use actix_http::cookie::SameSite;
|
|
///
|
|
/// let strict = SameSite::Strict;
|
|
/// assert!(strict.is_strict());
|
|
/// assert!(!strict.is_lax());
|
|
/// assert!(!strict.is_none());
|
|
/// ```
|
|
#[inline]
|
|
pub fn is_strict(self) -> bool {
|
|
match self {
|
|
SameSite::Strict => true,
|
|
SameSite::Lax | SameSite::None => false,
|
|
}
|
|
}
|
|
|
|
/// Returns `true` if `self` is `SameSite::Lax` and `false` otherwise.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// use actix_http::cookie::SameSite;
|
|
///
|
|
/// let lax = SameSite::Lax;
|
|
/// assert!(lax.is_lax());
|
|
/// assert!(!lax.is_strict());
|
|
/// assert!(!lax.is_none());
|
|
/// ```
|
|
#[inline]
|
|
pub fn is_lax(self) -> bool {
|
|
match self {
|
|
SameSite::Lax => true,
|
|
SameSite::Strict | SameSite::None => false,
|
|
}
|
|
}
|
|
|
|
/// Returns `true` if `self` is `SameSite::None` and `false` otherwise.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// use actix_http::cookie::SameSite;
|
|
///
|
|
/// let none = SameSite::None;
|
|
/// assert!(none.is_none());
|
|
/// assert!(!none.is_lax());
|
|
/// assert!(!none.is_strict());
|
|
/// ```
|
|
#[inline]
|
|
pub fn is_none(self) -> bool {
|
|
match self {
|
|
SameSite::None => true,
|
|
SameSite::Lax | SameSite::Strict => false,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for SameSite {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
match *self {
|
|
SameSite::Strict => write!(f, "Strict"),
|
|
SameSite::Lax => write!(f, "Lax"),
|
|
SameSite::None => write!(f, "None"),
|
|
}
|
|
}
|
|
}
|