Skip to main content

VendorClassifier

Struct VendorClassifier 

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

Vendor-classification engine.

Construct with VendorClassifier::with_builtin_defaults to load the four baseline Tier 1 vendor definitions shipped in crates/stygian-charon/data/vendors/, or VendorClassifier::new for an empty / custom registry.

The classifier is stateless and Send + Sync so it can be shared across threads and requests without locking.

§Example

use stygian_charon::vendor_classifier::{VendorClassifier, VendorId};
use std::collections::BTreeMap;

let empty = VendorClassifier::new(Vec::new());
let cookies: Vec<String> = Vec::new();
let headers: BTreeMap<String, String> = BTreeMap::new();
let classification = empty.classify(&cookies, &headers, None, "https://example.com/");
assert_eq!(classification.top_vendor, VendorId::Unknown);
assert!(classification.is_unknown());

Implementations§

Source§

impl VendorClassifier

Source

pub const fn new(definitions: Vec<VendorDefinition>) -> Self

Build a classifier from a pre-loaded list of VendorDefinition entries.

The threshold defaults to DEFAULT_HIGH_CONFIDENCE_THRESHOLD. Override with with_threshold.

Source

pub fn with_builtin_defaults() -> Self

Build a classifier seeded with the four baseline Tier 1 vendor definitions embedded at compile time from crates/stygian-charon/data/vendors/.

The compile-time check compile_check_builtin_vendors guarantees that every embedded TOML is valid; if it regresses, the build will fail.

§Example
use stygian_charon::vendor_classifier::{VendorClassifier, VendorId};

let classifier = VendorClassifier::with_builtin_defaults();
assert!(classifier.contains(VendorId::DataDome));
assert!(classifier.contains(VendorId::PerimeterX));
assert!(classifier.contains(VendorId::Akamai));
assert!(classifier.contains(VendorId::Cloudflare));
Source

pub fn with_threshold(self, threshold: f64) -> Self

Override the high-confidence threshold. The supplied value is clamped to (0.0, 1.0]. Non-finite values (NaN, ±∞) fall back to DEFAULT_HIGH_CONFIDENCE_THRESHOLD.

§Example
use stygian_charon::vendor_classifier::{VendorClassifier, DEFAULT_HIGH_CONFIDENCE_THRESHOLD};

let classifier = VendorClassifier::new(Vec::new()).with_threshold(0.85);
assert!((classifier.threshold() - 0.85).abs() < 1e-9);

// Out-of-range values clamp to the default.
let reset = VendorClassifier::new(Vec::new()).with_threshold(f64::NAN);
assert!((reset.threshold() - DEFAULT_HIGH_CONFIDENCE_THRESHOLD).abs() < 1e-9);
Source

pub const fn threshold(&self) -> f64

Configured high-confidence threshold.

Source

pub fn contains(&self, vendor: VendorId) -> bool

true when the registry contains a definition for the given VendorId.

Source

pub const fn len(&self) -> usize

Number of vendor definitions currently registered.

Source

pub const fn is_empty(&self) -> bool

true when the registry has no definitions.

Source

pub fn classify( &self, cookies: &[String], headers: &BTreeMap<String, String>, body: Option<&str>, url: &str, ) -> VendorClassification

Classify a single set of input strings (cookies, headers, optional body, request URL) into a ranked vendor classification.

The classifier scans every registered VendorDefinition’s signal catalogue and computes a per-vendor weighted score. The match is case-insensitive (definitions are lower-cased at load time, and the input strings are lower-cased at the match site). strings are lower-cased at the match site).

§Determinism
  • Signals are matched in (source, pattern) lex order.
  • Ties on the top score are broken by VendorId discriminant order (see module docs).
  • The output is Send + Sync and contains no HashMap/HashSet so the JSON form is byte-stable.
Source

pub fn classify_view(&self, tx: &TransactionView) -> VendorClassification

Convenience wrapper around classify that pulls the inputs out of a TransactionView.

Cookies are extracted from the set-cookie / cookie response header (everything else is treated as a generic header). The body is the response_body_snippet. The URL is tx.url.

Source

pub fn classify_har( &self, har_json: &str, ) -> Result<VendorClassification, HarError>

Classify every transaction in a HAR payload and return the top vendor’s classification. Cookies, headers, and body snippets are pulled from each HAR entry directly.

§Errors

Returns har::HarError when the HAR JSON is invalid or exceeds a configured safety limit.

Trait Implementations§

Source§

impl Clone for VendorClassifier

Source§

fn clone(&self) -> VendorClassifier

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 VendorClassifier

Source§

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

Formats the value using the given formatter. 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> 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<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