Enum soup::CookieJarAcceptPolicy

#[non_exhaustive]
pub enum CookieJarAcceptPolicy {
    Always,
    Never,
    NoThirdParty,
    GrandfatheredThirdParty,
}

The policy for accepting or rejecting cookies returned in responses.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Always

accept all cookies unconditionally.

Never

reject all cookies unconditionally.

NoThirdParty

accept all cookies set by the main document loaded in the application using libsoup. An example of the most common case, web browsers, would be: If http://www.example.com is the page loaded, accept all cookies set by example.com, but if a resource from http://www.third-party.com is loaded from that page reject any cookie that it could try to set. For libsoup to be able to tell apart first party cookies from the rest, the application must call Message::set_first_party() on each outgoing Message, setting the glib::Uri of the main document. If no first party is set in a message when this policy is in effect, cookies will be assumed to be third party by default.

GrandfatheredThirdParty

accept all cookies set by the main document loaded in the application using libsoup, and from domains that have previously set at least one cookie when loaded as the main document. An example of the most common case, web browsers, would be: if http://www.example.com is the page loaded, accept all cookies set by example.com, but if a resource from http://www.third-party.com is loaded from that page, reject any cookie that it could try to set unless it already has a cookie in the cookie jar. For libsoup to be able to tell apart first party cookies from the rest, the application must call Message::set_first_party() on each outgoing #SoupMessage, setting the glib::Uri of the main document. If no first party is set in a message when this policy is in effect, cookies will be assumed to be third party by default.

Trait Implementations

impl Clone for CookieJarAcceptPolicy

fn clone(&self) -> CookieJarAcceptPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CookieJarAcceptPolicy

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

Formats the value using the given formatter.

impl From<CookieJarAcceptPolicy> for Value

fn from(v: CookieJarAcceptPolicy) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for CookieJarAcceptPolicy

type Checker = GenericValueTypeChecker<CookieJarAcceptPolicy>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for CookieJarAcceptPolicy

type ParamSpec = ParamSpecEnum

type SetValue = CookieJarAcceptPolicy

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: CookieJarAcceptPolicy) -> ParamSpecEnumBuilder<'_, CookieJarAcceptPolicy>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CookieJarAcceptPolicy

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 CookieJarAcceptPolicy

fn cmp(&self, other: &CookieJarAcceptPolicy) -> 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 CookieJarAcceptPolicy

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

fn partial_cmp(&self, other: &CookieJarAcceptPolicy) -> 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 StaticType for CookieJarAcceptPolicy

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for CookieJarAcceptPolicy

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for CookieJarAcceptPolicy

type Type = CookieJarAcceptPolicy

Type to get the Type from.

impl Copy for CookieJarAcceptPolicy

impl Eq for CookieJarAcceptPolicy

impl StructuralPartialEq for CookieJarAcceptPolicy