Struct CustomMetricSelection

pub struct CustomMetricSelection<Calculation> { /* private fields */ }

A user-defined type metric that can be measured or turned into a predicate rule.

Implementations

impl<Calculation> CustomMetricSelection<Calculation>

where Calculation: Fn(&TypeInfo) -> f64,

pub fn should_be_below(self, threshold: f64) -> MetricThresholdCondition<Self>

Requires every measured value to be strictly below threshold.

pub fn should_be_above(self, threshold: f64) -> MetricThresholdCondition<Self>

Requires every measured value to be strictly above threshold.

pub fn should_be(self, threshold: f64) -> MetricThresholdCondition<Self>

Requires every measured value to equal threshold exactly.

pub fn should_be_below_or_equal( self, threshold: f64, ) -> MetricThresholdCondition<Self>

Requires every measured value to be below or equal to threshold.

pub fn should_be_above_or_equal( self, threshold: f64, ) -> MetricThresholdCondition<Self>

Requires every measured value to be above or equal to threshold.

pub fn measure(&self) -> Result<Vec<MetricMeasurement>, ArchUnitError>

Extracts and measures selected production-source types.

Panics from the custom calculation propagate normally.

pub fn measure_with( &self, check_options: &CheckOptions, ) -> Result<Vec<MetricMeasurement>, ArchUnitError>

Extracts and measures selected types with explicit source-target options.

Panics from the custom calculation propagate normally.

pub fn should_satisfy<Predicate>( self, predicate: Predicate, ) -> CustomMetricCondition<Calculation, Predicate>

where Predicate: Fn(f64, &TypeInfo) -> bool,

Creates a reusable rule whose predicate receives the value and the same type evidence.

Panics from either callback propagate normally.

pub fn name(&self) -> &str

Returns the user-defined metric name.

pub fn description(&self) -> &str

Returns the user-defined metric description.

Trait Implementations

impl<Calculation: Clone> Clone for CustomMetricSelection<Calculation>

fn clone(&self) -> CustomMetricSelection<Calculation>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Calculation: Debug> Debug for CustomMetricSelection<Calculation>

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

Formats the value using the given formatter.