Struct Cookie 

pub struct Cookie { /* private fields */ }

Implementations

impl Cookie

pub fn serialize_expire(&self, buf: &mut String) -> Result<(), Error>

impl Cookie

pub fn parse_cookie(string: impl Into<Box<str>>) -> Result<Cookie, Error>

impl Cookie

pub fn serialize(&self) -> Result<String, Error>

impl Cookie

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.

pub fn named<N>(name: N) -> Cookie

where N: Into<Cow<'static, str>>,

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

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 MaxAge 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.

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.

pub fn name(&self) -> &str

Returns the cookie name.

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

Set the cookie name.

pub fn value(&self) -> &str

Get the cookie value. Doesn’t trim " characters.

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

Set the cookie value.

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

Set the Expired attribute.

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

Get the MaxAge 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.

pub fn max_age_secs(&self) -> Option<u64>

Get the MaxAge as seconds.

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

Set the MaxAge attribute.

pub fn set_max_age_secs(&mut self, max_age_secs: u64)

Set the MaxAge value in seconds.

pub fn unset_max_age(&mut self)

Removes the MaxAge attribute.

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

Returns the Domain attribute if it’s set.

pub fn set_domain<D: Into<Cow<'static, str>>>(&mut self, domain: D)

Set the Domain attribute.

pub fn unset_domain(&mut self)

Removes the Domain attribute.

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

Returns the Path attribute if it’s set.

pub fn set_path<D: Into<Cow<'static, str>>>(&mut self, path: D)

Set the Path attribute.

pub fn unset_path(&mut self)

Removes the path attribute.

pub fn secure(&self) -> bool

Returns if the Secure attribute is set.

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

pub fn http_only(&self) -> bool

Returns if the HttpOnly attribute is set.

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

pub fn partitioned(&self) -> bool

Returns if the Partitioned attribute is set.

pub fn set_partitioned(&mut self, partitioned: bool)

Set the Partitioned flag, enabling the Partitioned attribute also enables the Secure Attribute.

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

Returns the SameSite attribute if it is set.

pub fn set_same_site<S: Into<Option<SameSite>>>(&mut self, same_site: S)

Set the SameSite attribute.

Trait Implementations

impl Borrow<Cookie> for CookieBuilder

fn borrow(&self) -> &Cookie

Immutably borrows from an owned value.

impl Clone for Cookie

fn clone(&self) -> Cookie

Returns a duplicate 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 Default for Cookie

fn default() -> Cookie

Returns the “default value” for a type.

impl Display for Cookie

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

Formats the value using the given formatter.

impl PartialEq for Cookie

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.