Struct Cookie

Source

pub struct Cookie { /* private fields */ }

Expand description

An HTTP Cookie.

Implementations§

Source

pub fn expires_time(&self) -> Option<OffsetDateTime>

Returns the Expires attribute using a OffsetDateTime.

Source

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

Returns the Max-Age attribute using a Duration.

Source

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

Returns the Expires attribute using chrono::DateTime.

Source

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

Returns the Max-Age attribute using chrono::Duration.

Source

pub fn expires_jiff(&self) -> Option<&Zoned>

Returns the Expires attribute using a Zoned.

Source

pub fn max_age_jiff(&self) -> Option<SignedDuration>

Returns the Max-Age attribute using a SignedDuration.

Source

pub fn is_expires_set(&self) -> bool

If the Expires attribute is not set, the expiration of the cookie is tied to the session with the user-agent.

Source

pub fn new<N, V>(name: N, value: V) -> Cookie
where N: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Creates a new cookie with the given name and value.

§Example

use cookie_monster::Cookie;

let cookie = Cookie::new("hello", "world");

assert_eq!(cookie.name(), "hello");
assert_eq!(cookie.value(), "world");

Source

pub fn remove<N>(name: N) -> Cookie
where N: Into<Cow<'static, str>>,

Creates a cookie that can be used to remove the cookie from the user-agent. This sets the Expires attribute in the past and Max-Age to 0 seconds.

To ensure a cookie is removed from the user-agent, set the Path and Domain attributes with the same values that were used to create the cookie.

§Note

You don’t have to use this method with crate::CookieJar::remove, the jar automatically set’s the Expires and Max-Age attributes.

§Example

use cookie_monster::Cookie;

let cookie = Cookie::remove("session");

assert_eq!(cookie.max_age_secs(), Some(0));
assert!(!cookie.is_expires_set());

Source

pub fn build<N, V>(name: N, value: V) -> CookieBuilder
where N: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Build a new cookie. This returns a CookieBuilder that can be used to set other attribute values.

§Example

use cookie_monster::Cookie;

let cookie = Cookie::build("foo", "bar")
    .secure()
    .http_only()
    .build();

assert!(cookie.secure());
assert!(cookie.http_only());

Source

pub fn named<N>(name: N) -> CookieBuilder
where N: Into<Cow<'static, str>>,

Creates a CookieBuilder with the given name and an empty value. This can be used when removing a cookie from a crate::CookieJar.

§Example

use cookie_monster::{Cookie, CookieJar};

let mut jar = CookieJar::empty();
jar.remove(Cookie::named("session").path("/login"));

assert!(jar.get("session").is_none());

Source

pub fn name(&self) -> &str

Returns the cookie name.

Source

pub fn set_name<N: Into<Cow<'static, str>>>(&mut self, name: N)

Set the cookie name.

Source

pub fn value(&self) -> &str

Get the cookie value. This does not trim " characters.

Source

pub fn set_value<V: Into<Cow<'static, str>>>(&mut self, value: V)

Set the cookie value.

Source

pub fn set_expires<E: Into<Expires>>(&mut self, expires: E)

Set the Expired attribute.

Source

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

Get the Max-Age duration. This returns a std::time::Duration, if you’d like a time, chrono or jiff specific duration use the max_age_{time,chrono,jiff} method.

Source