Struct PolicyRuleReport 

pub struct PolicyRuleReport {
    pub id: String,
    pub category: String,
    pub tier: RuleTier,
    pub level: RuleLevel,
    pub source: RuleLevelSource,
    pub corpus_noise_basis_points: Option<u16>,
    pub corpus_reviewed_sites: Option<u64>,
}

Fields

id: String

category: String

tier: RuleTier

level: RuleLevel

source: RuleLevelSource

corpus_noise_basis_points: Option<u16>

Smoothed false-positive rate of this rule on the pinned corpus, in basis points, absent when the corpus never adjudicated it.

It is published because it ranks: the report tells the user what to fix first by discounting each rule’s cost by this rate, so a rule with many findings can be left out of that list, and without the number the omission reads as a defect of the tool rather than a measurement.

corpus_reviewed_sites: Option<u64>

How many sites the rate above rests on.

A rate published alone is a rate the reader cannot weigh: one adjudicated site and forty adjudicated sites are two different claims, and the smoothing that separates them is invisible in the rate it produces. The two members move together, so a rule carrying neither is a rule the corpus never adjudicated rather than a rule measured at zero.

Trait Implementations

impl Clone for PolicyRuleReport

fn clone(&self) -> PolicyRuleReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicyRuleReport

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

Formats the value using the given formatter.

impl Eq for PolicyRuleReport

impl PartialEq for PolicyRuleReport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PolicyRuleReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PolicyRuleReport