Skip to main content

CoherencePolicy

Struct CoherencePolicy 

Source
pub struct CoherencePolicy { /* private fields */ }
Expand description

Policy configuring how [crate::manager::ProxyManager::acquire_proxy_with_coherence] reacts to a CoherenceVerdict::Mismatch.

The default CoherencePolicy::advisory policy never blocks; every mismatch is logged and the proxy is returned. Operators opt into blocking via CoherencePolicy::hard_fail_on or the CoherencePolicy::with_hard_fail builder step.

Implementations§

Source§

impl CoherencePolicy

Source

pub const fn advisory() -> Self

Advisory-only policy: every mismatch is logged, none block.

§Example
use stygian_proxy::ports::coherence::{CoherencePolicy, MismatchField};
let policy = CoherencePolicy::advisory();
assert!(!policy.is_hard_fail(MismatchField::ProxyGeoVsDns));
assert!(policy.is_advisory_only());
Source

pub fn hard_fail_on(field: MismatchField) -> Self

Build a policy that fails on a single hard-mismatch field.

§Example
use stygian_proxy::ports::coherence::{CoherencePolicy, MismatchField, MismatchSeverity};
let policy = CoherencePolicy::hard_fail_on(MismatchField::WebRtcPublicIp);
assert!(policy.is_hard_fail(MismatchField::WebRtcPublicIp));
assert_eq!(policy.severity(MismatchField::WebRtcPublicIp), MismatchSeverity::Hard);
assert!(!policy.is_hard_fail(MismatchField::Timezone));
Source

pub fn with_hard_fail(self, field: MismatchField) -> Self

Builder step: register an additional hard-fail field.

§Example
use stygian_proxy::ports::coherence::{CoherencePolicy, MismatchField};
let policy = CoherencePolicy::advisory()
    .with_hard_fail(MismatchField::ProxyGeoVsDns)
    .with_hard_fail(MismatchField::WebRtcPublicIp);
assert!(policy.is_hard_fail(MismatchField::ProxyGeoVsDns));
assert!(policy.is_hard_fail(MismatchField::WebRtcPublicIp));
assert!(!policy.is_hard_fail(MismatchField::Timezone));
Source

pub fn contains(&self, field: MismatchField) -> bool

Returns true when field is registered as a hard-fail vector.

§Example
use stygian_proxy::ports::coherence::{CoherencePolicy, MismatchField};
let policy = CoherencePolicy::hard_fail_on(MismatchField::Timezone);
assert!(policy.is_hard_fail(MismatchField::Timezone));
assert!(!policy.is_hard_fail(MismatchField::Locale));
Source

pub fn is_hard_fail(&self, field: MismatchField) -> bool

Alias for CoherencePolicy::contains matching the policy.is_hard_fail(field) shape used in the rustdoc examples above.

Source

pub fn is_advisory_only(&self) -> bool

Returns true when no field is registered for hard-fail.

Source

pub fn severity(&self, field: MismatchField) -> MismatchSeverity

Severity under which the policy blocks a request on field.

Always MismatchSeverity::Hard for registered fields and MismatchSeverity::Advisory otherwise. Used by the manager to decide whether a given CoherenceVerdict::Mismatch should fail the acquisition or just be logged.

Source

pub fn hard_fail_count(&self) -> usize

Number of registered hard-fail fields.

Trait Implementations§

Source§

impl Clone for CoherencePolicy

Source§

fn clone(&self) -> CoherencePolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoherencePolicy

Source§

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

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

impl Default for CoherencePolicy

Source§

fn default() -> CoherencePolicy

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

impl<'de> Deserialize<'de> for CoherencePolicy

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 Eq for CoherencePolicy

Source§

impl PartialEq for CoherencePolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for CoherencePolicy

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
Source§

impl StructuralPartialEq for CoherencePolicy

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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> 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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