Struct poem::web::cookie::Cookie [−][src]
pub struct Cookie(_);
cookie
only.Expand description
Implementations
Creates a new Cookie with the given name
and serialized value
.
Creates a new Cookie with the given name
and value
.
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());
Parses a Cookie from the given HTTP cookie header value string.
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"));
Returns the expiration date-time of the cookie if one was specified.
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());
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))
);
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)));
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)));
Returns the name of self
.
Example
use poem::web::cookie::Cookie;
let cookie = Cookie::parse("foo=bar").unwrap();
assert_eq!(cookie.name(), "foo");
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"));
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));
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());
Sets the domain
of self
to domain
.
Sets the expires field of self
to time
.
Sets the value of HttpOnly
in self
to value
.
Sets the value of MaxAge
in self
to value
.
Sets the value of SameSite
in self
to value
.
Sets the value of Secure
in self
to value
.
Sets the value of self
to value
.
Sets the value of self
to the serialized value
.
Returns the value of self
to the deserialized value
.
Trait Implementations
fn from_request<'life0, 'async_trait>(
req: &'a Request,
_body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
fn from_request<'life0, 'async_trait>(
req: &'a Request,
_body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
Extract from request head and body.
Auto Trait Implementations
impl RefUnwindSafe for Cookie
impl UnwindSafe for Cookie
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more