Struct Cookie 

pub struct Cookie { /* private fields */ }

Represents a cookie created from Set-Cookie response header.

A Cookie can be parsed from the Set-Cookie value from an HTTP Response using the trait FromStr:

let cookie = Cookie::from_str("id=a3fWa; Expires=Wed, 21 Oct 2022 07:28:00 GMT");

See RFC6265 Set-Cookie for more information.

Implementations

impl Cookie

pub fn new(name: String, value: String, domain: String, path: String) -> Cookie

Constructor. It takes ownership params:

• name: Cookie name
• value: Cookie value, for binary data it is recommended Base64 encoding.
• domain: Cookie domain, sets hosts (domain and subdomains) to which the cookie will be sent, in includes subdomains. If not present in Set-Cookie header, it is taken from the HTTP request Host header
• path: Cookie path, paths (same path or children) to which the cookie will be sent If not present in Set-Cookie header, it is taken from the HTTP request path

pub fn name(&self) -> &str

Cookie name

pub fn value(&self) -> &str

Cookie value

pub fn domain(&self) -> &str

Cookie domain: hosts to which the cookie will be sent

pub fn path(&self) -> &str

Cookie path

pub fn expires(&self) -> Option<SystemTime>

When the Cookie expires, if None, it does not expire. This value is obtained from Max-Age and Expires attributes (Max-Age has precedence)

pub fn same_site(&self) -> SameSiteValue

Cookie Same-Site value (optional)

pub fn secure(&self) -> bool

Cookie requires HTTPS

pub fn http_only(&self) -> bool

Cookie requires HTTP only

pub fn extensions(&self) -> &HashMap<String, String>

Cookie extendions

pub fn path_match(&self, request_path: &str) -> bool

Checks if the request path match the cookie path.

Using RFC6265 Section 5.1.4 Algorithm.

pub fn domain_match(&self, request_domain: &str) -> bool

Checks if the request domain match the cookie domain.

Using RFC6265 Section 4.1.1.3.

pub fn request_match( &self, request_domain: &str, request_path: &str, secure: bool, ) -> bool

Checks if the cookie can be used on this request

pub fn parse(s: &str, domain: &str, path: &str) -> Result<Cookie, Error>

Parses a cookie value and modifiers from a ’Set-Cookie’header

Trait Implementations

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 Hash for Cookie

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cookie

fn eq(&self, other: &Self) -> 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.

impl Eq for Cookie