Struct AnalysisOptions 

pub struct AnalysisOptions { /* private fields */ }

What to analyze, and how, for a single profiling run.

Construct with AnalysisOptions::default (analyze everything) and narrow with the builder methods.

Implementations

impl AnalysisOptions

pub fn with_metric_packs(self, packs: Option<Vec<MetricPack>>) -> Self

Select the metric packs to compute. None (the default) means all.

pub fn with_quality_dimensions( self, dimensions: Option<Vec<QualityDimension>>, ) -> Self

Select the quality dimensions to assess. None (the default) means all.

pub fn with_locale(self, locale: Option<Locale>) -> Self

Set the locale used to rank detected patterns.

Parse a user-supplied tag with Locale::parse_optional first, so an unrecognised tag is rejected where it is written rather than silently suppressing every locale-specific pattern.

pub fn with_semantic_hints(self, hints: SemanticHints) -> Self

Set the user’s semantic hints.

pub fn effective_metric_packs(&self) -> Option<Vec<MetricPack>>

The packs to compute, with an empty quality-dimension selection folded in.

Resolved on read rather than in the setters so the outcome does not depend on the order the selections were made in.

pub fn include_statistics(&self) -> bool

Whether per-column statistics should be computed.

pub fn include_patterns(&self) -> bool

Whether pattern detection should run.

pub fn include_quality(&self) -> bool

Whether quality metrics should be computed.

false means the report carries no quality at all — absent, not an empty assessment — because nothing was analyzed.

pub fn locale(&self) -> Option<Locale>

The locale used to rank detected patterns.

A locale only ranks patterns, so it has no effect of its own when include_patterns is false and detection never runs.

pub fn quality_dimensions(&self) -> Option<&[QualityDimension]>

The requested quality dimensions, if the caller narrowed them.

pub fn semantic_hints(&self) -> &SemanticHints

The user’s semantic hints.

Trait Implementations

impl Clone for AnalysisOptions

fn clone(&self) -> AnalysisOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnalysisOptions

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

Formats the value using the given formatter.

impl Default for AnalysisOptions

fn default() -> AnalysisOptions

Returns the “default value” for a type.

impl Eq for AnalysisOptions

impl PartialEq for AnalysisOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnalysisOptions