Struct soup::HSTSPolicy

pub struct HSTSPolicy { /* private fields */ }

#SoupHSTSPolicy implements HTTP policies, as described by RFC 6797.

@domain represents the host that this policy applies to. The domain must be IDNA-canonicalized. HSTSPolicy::new() and related methods will do this for you.

@max_age contains the ‘max-age’ value from the Strict Transport Security header and indicates the time to live of this policy, in seconds.

@expires will be non-None if the policy has been set by the host and hence has an expiry time. If @expires is None, it indicates that the policy is a permanent session policy set by the user agent.

If @include_subdomains is true, the Strict Transport Security policy must also be enforced on subdomains of @domain.

Implementations

impl HSTSPolicy

pub fn as_ptr(&self) -> *mut SoupHSTSPolicy

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const SoupHSTSPolicy ) -> &'a Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut *mut SoupHSTSPolicy ) -> &'a mut Self

Borrows the underlying C value mutably.

impl HSTSPolicy

pub fn new( domain: &str, max_age: c_ulong, include_subdomains: bool ) -> HSTSPolicy

Creates a new #SoupHSTSPolicy with the given attributes.

@domain is a domain on which the strict transport security policy represented by this object must be enforced.

@max_age is used to set the “expires” attribute on the policy; pass SOUP_HSTS_POLICY_MAX_AGE_PAST for an already-expired policy, or a lifetime in seconds.

If @include_subdomains is true, the strict transport security policy must also be enforced on all subdomains of @domain.

domain

policy domain or hostname

max_age

max age of the policy

include_subdomains

true if the policy applies on subdomains

Returns

a new #SoupHSTSPolicy.

pub fn from_response(msg: &Message) -> Option<HSTSPolicy>

Parses @msg’s first “Strict-Transport-Security” response header and returns a #SoupHSTSPolicy.

msg

a #SoupMessage

Returns

a new #SoupHSTSPolicy, or None if no valid “Strict-Transport-Security” response header was found.

pub fn new_full( domain: &str, max_age: c_ulong, expires: &DateTime, include_subdomains: bool ) -> HSTSPolicy

Full version of HSTSPolicy::new(), to use with an existing expiration date.

See HSTSPolicy::new() for details.

domain

policy domain or hostname

max_age

max age of the policy

expires

the date of expiration of the policy or None for a permanent policy

include_subdomains

true if the policy applies on subdomains

Returns

a new #SoupHSTSPolicy.

pub fn new_session_policy(domain: &str, include_subdomains: bool) -> HSTSPolicy

Creates a new session #SoupHSTSPolicy with the given attributes.

A session policy is a policy that is valid during the lifetime of the HSTSEnforcer it is added to. Contrary to regular policies, it has no expiration date and is not stored in persistent enforcers. These policies are useful for user-agent to load their own or user-defined rules.

@domain is a domain on which the strict transport security policy represented by this object must be enforced.

If @include_subdomains is true, the strict transport security policy must also be enforced on all subdomains of @domain.

domain

policy domain or hostname

include_subdomains

true if the policy applies on sub domains

Returns

a new #SoupHSTSPolicy.

pub fn domain(&mut self) -> Option<GString>

Gets @self’s domain.

Returns

@self’s domain.

pub fn expires(&mut self) -> Option<DateTime>

Returns the expiration date for @self.

Returns

A #GDateTime or None if unset

pub fn max_age(&mut self) -> c_ulong

Returns the max age for @self.

Returns

Max age in seconds

pub fn includes_subdomains(&mut self) -> bool

Gets whether @self include its subdomains.

Returns

true if @self includes subdomains, false otherwise.

pub fn is_expired(&mut self) -> bool

Gets whether @self is expired.

Permanent policies never expire.

Returns

true if @self is expired, false otherwise.

pub fn is_session_policy(&mut self) -> bool

Gets whether @self is a non-permanent, non-expirable session policy.

See HSTSPolicy::new_session_policy() for details.

Returns

true if @self is permanent, false otherwise

Trait Implementations

impl Clone for HSTSPolicy

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HSTSPolicy

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

Formats the value using the given formatter.

impl From<HSTSPolicy> for Value

fn from(o: HSTSPolicy) -> Self

Converts to this type from the input type.

impl HasParamSpec for HSTSPolicy

type ParamSpec = ParamSpecBoxed

type SetValue = HSTSPolicy

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

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, HSTSPolicy>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for HSTSPolicy

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 HSTSPolicy

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for HSTSPolicy

impl StructuralPartialEq for HSTSPolicy