Struct poem::web::cookie::Cookie

pub struct Cookie(_);

This is supported on crate feature cookie only.

Representation of an HTTP cookie.

Implementations

impl Cookie

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

Creates a new Cookie with the given name and serialized value.

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

Creates a new Cookie with the given name and value.

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

Creates a new Cookie with the given name and an empty value.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::named("foo");
assert_eq!(cookie.name(), "foo");
assert!(cookie.value_str().is_empty());

pub fn parse(s: impl AsRef<str>) -> Result<Self, ParseCookieError>

Parses a Cookie from the given HTTP cookie header value string.

pub fn domain(&self) -> Option<&str>

Returns the Domain of the cookie if one was specified.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar; domain=example.com").unwrap();
assert_eq!(cookie.domain(), Some("example.com"));

pub fn expires(&self) -> Option<DateTime<Utc>>

Returns the expiration date-time of the cookie if one was specified.

pub fn http_only(&self) -> bool

Returns whether this cookie was marked HttpOnly or not.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar; HttpOnly").unwrap();
assert!(cookie.http_only());

pub fn make_permanent(&mut self)

Makes self a permanent cookie by extending its expiration and max age 20 years into the future.

Example

use std::time::Duration;

use poem::web::cookie::Cookie;

let mut cookie = Cookie::new_with_str("foo", "bar");
cookie.make_permanent();
assert_eq!(
    cookie.max_age(),
    Some(Duration::from_secs(60 * 60 * 24 * 365 * 20))
);

pub fn make_removal(&mut self)

Make self a removal cookie by clearing its value, setting a max-age of 0, and setting an expiration date far in the past.

Example

use std::time::Duration;

use poem::web::cookie::Cookie;

let mut cookie = Cookie::new_with_str("foo", "bar");
cookie.make_removal();
assert_eq!(cookie.max_age(), Some(Duration::from_secs(0)));

pub fn max_age(&self) -> Option<Duration>

Returns the specified max-age of the cookie if one was specified.

Example

use std::time::Duration;

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar; Max-Age=3600").unwrap();
assert_eq!(cookie.max_age(), Some(Duration::from_secs(3600)));

pub fn name(&self) -> &str

Returns the name of self.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar").unwrap();
assert_eq!(cookie.name(), "foo");

pub fn path(&self) -> Option<&str>

Returns the Path of the cookie if one was specified.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar; path=/api").unwrap();
assert_eq!(cookie.path(), Some("/api"));

pub fn same_site(&self) -> Option<SameSite>

Returns the SameSite attribute of this cookie if one was specified.

Example

use poem::web::cookie::{Cookie, SameSite};

let cookie = Cookie::parse("foo=bar; SameSite=Strict").unwrap();
assert_eq!(cookie.same_site(), Some(SameSite::Strict));

pub fn secure(&self) -> bool

Returns whether this cookie was marked Secure or not.

Example

use poem::web::cookie::Cookie;

let cookie = Cookie::parse("foo=bar; Secure").unwrap();
assert!(cookie.secure());

pub fn set_domain(&mut self, domain: impl Into<String>)

Sets the domain of self to domain.

pub fn set_expires(&mut self, time: DateTime<impl TimeZone>)

Sets the expires field of self to time.

pub fn set_http_only(&mut self, value: bool)

Sets the value of HttpOnly in self to value.

pub fn set_max_age(&mut self, value: Duration)

Sets the value of MaxAge in self to value.

pub fn set_name(&mut self, name: impl Into<String>)

Sets the name of self to name.

pub fn set_path(&mut self, path: impl Into<String>)

Sets the path of self to path.

pub fn set_same_site(&mut self, value: SameSite)

Sets the value of SameSite in self to value.

pub fn set_secure(&mut self, value: bool)

Sets the value of Secure in self to value.

pub fn set_value_str(&mut self, value: impl Into<String>)

Sets the value of self to value.

pub fn set_value(&mut self, value: impl Serialize)

Sets the value of self to the serialized value.

pub fn value_str(&self) -> &str

Returns the value of self.

pub fn value<'de, T: Deserialize<'de>>(&'de self) -> Result<T, ParseCookieError>

Returns the value of self to the deserialized value.

Trait Implementations

impl Clone for Cookie

fn clone(&self) -> Cookie

Returns a copy 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 Display for Cookie

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

Formats the value using the given formatter.

impl<'a> FromRequest<'a> for Cookie

type Error = ParseCookieError

The error type of this extractor.

fn from_request<'life0, 'async_trait>(
    req: &'a Request,
    _body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform the extraction.

impl PartialEq<Cookie> for Cookie

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

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

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

This method tests for !=.

impl StructuralPartialEq for Cookie