Skip to main content

FreshnessPolicy

Struct FreshnessPolicy 

Source
pub struct FreshnessPolicy {
    pub kind: FreshnessPolicyKind,
    pub domain_class_overrides: HashMap<String, DomainClass>,
    pub default_max_age_ms: u64,
    pub hostile_max_age_ms: u64,
    pub authenticated_max_age_ms: u64,
    pub sensitive_max_age_ms: u64,
    pub signature_required: bool,
}
Expand description

Configurable TTL and signature policy for freshness contracts.

The default TTLs are tuned for typical scraping workflows; callers can override them per-policy via FreshnessPolicy::with_overrides or per-domain via FreshnessPolicy::with_domain_override.

§Example

use stygian_browser::freshness::{DomainClass, FreshnessPolicy};
use std::time::Duration;

let mut policy = FreshnessPolicy::default();
policy = policy.with_domain_override("accounts.example.com", Some(DomainClass::Sensitive));
assert_eq!(policy.class_for("accounts.example.com"), DomainClass::Sensitive);
assert_eq!(
    policy.max_age_for("accounts.example.com"),
    Duration::from_millis(policy.max_age_ms_for(DomainClass::Sensitive))
);

Fields§

§kind: FreshnessPolicyKind

Policy band for short-circuit classification (logging, telemetry).

§domain_class_overrides: HashMap<String, DomainClass>

Per-domain class overrides keyed by lowercased host.

§default_max_age_ms: u64

Default max-age in milliseconds.

§hostile_max_age_ms: u64

Max-age for DomainClass::Hostile in milliseconds.

§authenticated_max_age_ms: u64

Max-age for DomainClass::Authenticated in milliseconds.

§sensitive_max_age_ms: u64

Max-age for DomainClass::Sensitive in milliseconds.

§signature_required: bool

When true, contracts without a signature are rejected regardless of TTL.

Implementations§

Source§

impl FreshnessPolicy

Source

pub fn with_kind(kind: FreshnessPolicyKind) -> Self

Build a policy with explicit kind and default TTLs.

Source

pub const fn tightened(self, factor: f64) -> Self

Tighten all TTLs by factor (e.g. 0.5 for half-life).

Source

pub fn with_domain_override( self, host: &str, class: Option<DomainClass>, ) -> Self

Override the DomainClass for host.

host is normalised to lower-case ASCII before being inserted. Pass None to clear an existing override.

Source

pub fn with_overrides(self, overrides: HashMap<String, DomainClass>) -> Self

Replace the full override map at once.

Source

pub const fn with_signature_required(self, required: bool) -> Self

Set whether contracts without a signature are rejected.

Source

pub fn class_for(&self, host: &str) -> DomainClass

Resolve the DomainClass for a host.

Lookup walks the override map first, then falls back to heuristics that recognise well-known challenge issuers (captcha, challenge, auth, login, accounts, payment, checkout) as DomainClass::Sensitive.

Source

pub fn for_domain(&self, host: &str) -> DomainClass

Convenience wrapper that returns the DomainClass for host via Self::class_for.

Source

pub const fn max_age_ms_for(&self, class: DomainClass) -> u64

Max-age in milliseconds for a given class.

Source

pub fn max_age_for(&self, host: &str) -> Duration

Max-age as a Duration for host.

Source

pub fn build_contract( &self, host: &str, signature: Option<&str>, ) -> Result<FreshnessContract, FreshnessError>

Build a contract for host capturing the current wall-clock and signature (when known). The max-age is resolved via Self::max_age_for.

§Errors

Returns FreshnessError::InvalidContract when host is empty or signature is empty.

Trait Implementations§

Source§

impl Clone for FreshnessPolicy

Source§

fn clone(&self) -> FreshnessPolicy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FreshnessPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FreshnessPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for FreshnessPolicy

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FreshnessPolicy

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,