Skip to main content

PredicateDebugReport

Struct PredicateDebugReport 

Source
pub struct PredicateDebugReport {
    pub total_candidates: usize,
    pub matched: usize,
    pub clause_stats: BTreeMap<String, ClauseStats>,
}
Expand description

Aggregate report from running a Predicate across a corpus of candidate evaluation contexts.

Phase 6 of CAPABILITY_ENHANCEMENTS_PLAN.md. Built by PredicateDebugReport::from_evaluations.

The report answers: “given this predicate and these candidates, how many matched, and how often did each clause filter?”. A clause with 1042 evaluations and 12 matches has 1.2% positive selectivity — operators use that to spot mismatches between their mental model of the data and the actual data.

Fields§

§total_candidates: usize

Number of candidates the predicate was evaluated against.

§matched: usize

Number of candidates the predicate matched (returned true).

§clause_stats: BTreeMap<String, ClauseStats>

Per-clause aggregated stats, keyed by the clause’s debug label. BTreeMap for deterministic iteration order in printed output.

Implementations§

Source§

impl PredicateDebugReport

Source

pub fn from_evaluations<'a, I>(pred: &Predicate, contexts: I) -> Self
where I: IntoIterator<Item = EvalContext<'a>>,

Run pred against each context in contexts, accumulating per-clause hit / miss stats.

Each context contributes one trace; the trace tree is walked post-order to update the per-label ClauseStats. Composite clauses (And / Or / Not) get their own labels too, so an operator can see “the And short-circuited 730/1042 times” at a glance.

Source

pub fn render(&self) -> String

Format a human-readable summary suitable for terminal output.

Returned as a String rather than printed directly so tests can pin the format and callers can route to their own logger.

Trait Implementations§

Source§

impl Clone for PredicateDebugReport

Source§

fn clone(&self) -> PredicateDebugReport

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 PredicateDebugReport

Source§

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

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

impl Default for PredicateDebugReport

Source§

fn default() -> PredicateDebugReport

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

impl PartialEq for PredicateDebugReport

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PredicateDebugReport

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.

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