Struct MetricSet 

pub struct MetricSet(/* private fields */);

Bitfield of selected metrics.

Stored on MetricsOptions (controls which metrics the walker computes) and on CodeMetrics (controls which fields the Serialize impl emits).

MetricSet::all() is the default: every metric enabled, matching the pre-#257 behaviour.

Implementations

impl MetricSet

pub const fn empty() -> Self

Empty set (no metrics selected).

pub const fn all() -> Self

Full set (every metric selected). This is the default for MetricsOptions, preserving the pre-#257 “compute everything” behaviour.

pub const fn contains(self, metric: Metric) -> bool

Returns true if metric is in the set.

pub const fn with(self, metric: Metric) -> Self

Returns a new set with metric inserted.

pub const fn union(self, other: Self) -> Self

Returns the union of two sets.

pub fn insert(&mut self, metric: Metric)

Insert metric (in place).

pub fn from_slice_with_deps(metrics: &[Metric]) -> Self

Build a MetricSet from a slice, auto-adding the transitive dependencies of each selected metric.

This is the workhorse behind MetricsOptions::with_only: the caller-facing builder enforces the full dependency closure so a request for Mi alone still computes Loc + Cyclomatic + Halstead. Exposed pub because downstream consumers (notably the bca Python bindings’ parse_metric_names helper) parse user input into a Vec<Metric> and need the same closure-resolution semantics without re-implementing the worklist.

Implementation note: uses a worklist rather than a single pass so a future derived metric whose dependency is itself derived still resolves the complete closure. The loop terminates because each iteration either inserts a new bit or the worklist drains; the bitfield is bounded at Metric variant count.

pub fn resolved(self) -> Self

Returns this set closed under Metric::dependencies.

Every selected metric’s transitive dependencies are added so a set carrying a derived metric (e.g. Metric::Mi) also carries the inputs that metric’s finalize step consumes (Metric::Loc, Metric::Cyclomatic, Metric::Halstead). Resolving an already-closed set is a no-op, so the operation is idempotent: set.resolved().resolved() == set.resolved().

This is the set-in/set-out counterpart of MetricSet::from_slice_with_deps and is what MetricsOptions::with_metric_set applies so a caller-supplied set can never select a derived metric without its prerequisites (#743).

Implementation note: uses a worklist rather than a single pass so a future derived metric whose dependency is itself derived still resolves the complete closure. The loop terminates because each iteration either inserts a new bit or the worklist drains; the bitfield is bounded at Metric variant count.

Trait Implementations

impl Clone for MetricSet

fn clone(&self) -> MetricSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MetricSet

impl Debug for MetricSet

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

Formats the value using the given formatter.

impl Default for MetricSet

fn default() -> Self

Default = every metric selected, matching the pre-#257 behaviour of MetricsOptions::default.

impl Eq for MetricSet

impl Hash for MetricSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MetricSet

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MetricSet