Struct MetricsBuilder

pub struct MetricsBuilder { /* private fields */ }

Immutable file/type selection for metrics extraction.

Implementations

impl MetricsBuilder

pub fn with_name(self, pattern: impl Into<PatternSpec>) -> Self

Keeps source files whose final path segment matches pattern.

pub fn in_folder(self, pattern: impl Into<PatternSpec>) -> Self

Keeps source files whose containing folder matches pattern.

pub fn in_path(self, pattern: impl Into<PatternSpec>) -> Self

Keeps source files whose normalized project path matches pattern.

pub fn for_types_matching(self, pattern: impl Into<PatternSpec>) -> Self

Keeps Rust type declarations whose unqualified name matches pattern.

When present, files without a matching type are omitted. File-level type and trait counts describe only the retained declarations; source-wide counts such as lines and imports remain properties of the containing file.

pub fn analyze(&self) -> Result<ProjectMetricsInfo, ArchUnitError>

Extracts the selected information model with production-source defaults.

pub fn analyze_with( &self, check_options: &CheckOptions, ) -> Result<ProjectMetricsInfo, ArchUnitError>

Extracts the selected information model with explicit source-target options.

pub fn count(self) -> CountMetricsBuilder

Enters the built-in count metric family.

pub fn lcom(self) -> LcomMetricsBuilder

Enters the lack-of-cohesion metric family for eligible Rust structs.

pub fn distance(self) -> DistanceMetricsBuilder

Enters the file-component distance metric family.

pub fn custom_metric<Calculation>( self, name: impl Into<String>, description: impl Into<String>, calculation: Calculation, ) -> CustomMetricSelection<Calculation>

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

Defines a reusable numeric metric over every selected Rust type.

The calculation receives an immutable TypeInfo and is invoked once per type on each execution. Panics from the user callback propagate normally.

pub fn project_path(&self) -> Option<&Path>

Returns the explicit discovery path, or None for automatic discovery.

Trait Implementations

impl Clone for MetricsBuilder

fn clone(&self) -> MetricsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricsBuilder

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

Formats the value using the given formatter.