Skip to main content

RuleCoverage

Struct RuleCoverage 

Source
pub struct RuleCoverage {
    pub by_rule: BTreeMap<RuleId, BTreeSet<String>>,
    pub by_class: BTreeMap<PayloadClass, BTreeSet<RuleId>>,
}
Expand description

Accumulates (payload, rule_id) observations from live bench runs and exposes coverage analytics used by the --coverage-report flag.

Two complementary indices are maintained:

  • by_rulerule_id → set of distinct payloads that triggered it
  • by_classpayload_class → set of rule_ids it has reached

Both are updated atomically on every record call so the coverage report is always consistent.

Fields§

§by_rule: BTreeMap<RuleId, BTreeSet<String>>

rule_id → set of payload fingerprints (first 64 chars) observed.

§by_class: BTreeMap<PayloadClass, BTreeSet<RuleId>>

payload_class → set of rule_ids reached from that class.

Implementations§

Source§

impl RuleCoverage

Source

pub fn new() -> Self

Create an empty coverage tracker.

Source

pub fn record(&mut self, payload: &str, rule_id: Option<&str>)

Record one (payload, rule_id) observation.

rule_id = None means the request was not blocked (or the block reason couldn’t be extracted) — the payload class is still indexed in by_class under a synthetic sentinel so “no rule triggered” coverage is visible in the report.

Source

pub fn coverage_report(&self) -> String

Produce a human-readable coverage summary.

Each line is rule_id payload_count separated by a tab, sorted by rule id. Suitable for --coverage-report output.

Source

pub fn rule_count(&self) -> usize

Number of distinct rule IDs observed so far.

Source

pub fn triggered_rules(&self) -> Vec<&RuleId>

Rules that have been triggered at least once in this run.

Source

pub fn to_json(&self) -> Result<String, Error>

Serialize the coverage map to compact JSON.

§Errors

Returns serde_json::Error if serialization fails (only possible if the in-memory types contain non-string-keyed maps, which they cannot for BTreeMap<RuleId, _>).

Source

pub fn from_json(json: &str) -> Result<Self, Error>

Deserialize a coverage map from JSON produced by to_json.

§Errors

Returns serde_json::Error on malformed JSON.

Trait Implementations§

Source§

impl Clone for RuleCoverage

Source§

fn clone(&self) -> RuleCoverage

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 RuleCoverage

Source§

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

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

impl Default for RuleCoverage

Source§

fn default() -> RuleCoverage

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

impl<'de> Deserialize<'de> for RuleCoverage

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 RuleCoverage

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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<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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

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

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

Source§

fn vzip(self) -> V

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