Enum cookie_store::CookieDomain

pub enum CookieDomain {
    HostOnly(String),
    Suffix(String),
    NotPresent,
    Empty,
}

The domain of a Cookie

Variants

HostOnly(String)

No Domain attribute in Set-Cookie header

Suffix(String)

Domain attribute from Set-Cookie header

NotPresent

Domain attribute was not present in the Set-Cookie header

Empty

Domain attribute-value was empty; technically undefined behavior, but suggested that this be treated as invalid

Implementations

impl CookieDomain

The concept of a domain match per IETF RFC6265 Section 5.1.3

pub fn host_only(request_url: &Url) -> Result<CookieDomain, CookieError>

Get the CookieDomain::HostOnly variant based on request_url. This is the effective behavior of setting the domain-attribute to empty

pub fn matches(&self, request_url: &Url) -> bool

Tests if the given url::Url meets the domain-match criteria

pub fn host_is_identical(&self, request_url: &Url) -> bool

Tests if the given url::Url has a request-host identical to the domain attribute

pub fn is_public_suffix(&self, psl: &List) -> bool

Tests if the domain-attribute is a public suffix as indicated by the provided publicsuffix::List.

pub fn as_cow(&self) -> Option<Cow<'_, str>>

Get a borrowed string representation of the domain. For Empty and NotPresent variants, None shall be returned;

Trait Implementations

impl Clone for CookieDomain

fn clone(&self) -> CookieDomain

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CookieDomain

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CookieDomain

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a CookieDomain> for String

fn from(c: &'a CookieDomain) -> String

Converts to this type from the input type.

impl Hash for CookieDomain

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 Ord for CookieDomain

fn cmp(&self, other: &CookieDomain) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CookieDomain

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

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

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

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

impl PartialOrd for CookieDomain

fn partial_cmp(&self, other: &CookieDomain) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CookieDomain

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, 'c> TryFrom<&'a Cookie<'c>> for CookieDomain

Construct a CookieDomain::Suffix from a cookie::Cookie, which handles stripping a leading ‘.’ for us. If the cookie.domain is None or an empty string, the CookieDomain::Empty variant is returned. NOTE: cookie::Cookie domain values already have the leading ‘.’ stripped. To avoid performing this step twice, the From<&cookie::Cookie> impl should be used, instead of passing cookie.domain to the From<&str> impl.

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(cookie: &'a RawCookie<'c>) -> Result<CookieDomain, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for CookieDomain

Construct a CookieDomain::Suffix from a string, stripping a single leading ‘.’ if present. If the source string is empty, returns the CookieDomain::Empty variant.

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<CookieDomain, Self::Error>

Performs the conversion.

impl Eq for CookieDomain

impl StructuralPartialEq for CookieDomain