Enum MetricScope 

pub enum MetricScope {
    File,
    Function,
    Container,
}

The space kind a metric’s threshold is meaningful on (issue #969).

A threshold gate (bca check, the Python to_sarif binding) walks every crate::FuncSpace — the file-level SpaceKind::Unit root, every container (class / impl / …), and every individual function. For the subtree-summed accessors a metric’s value at any space that owns children is a sum across many functions, so a per-function limit would fire on every non-trivial file and multi-method impl. Scope records the kind each metric actually measures so the front-ends gate it there and nowhere else — keeping the CLI gate and the binding in lockstep, the same way Direction keeps their breach direction aligned.

Variants

File

Gate only the whole-file SpaceKind::Unit root — the loc.* size family, whose limit is a per-file ceiling.

Function

Gate only individual function spaces (SpaceKind::Function — free functions, methods, closures). The per-function complexity metrics (cognitive, cyclomatic, abc, mi.) and the subtree sums that describe one function (halstead., nargs, nexits, tokens) live here.

Whether “one function” includes its nested closures is per metric, not per scope. halstead.*, nexits and tokens read subtree sums, because a closure’s tokens and exits really are part of the enclosing body a reader must follow. nargs reads the space’s own parameters instead (#1196): a closure that opens its own space is gated on its own row, and summing its arguments into the enclosing signature made the offender’s number describe something its remediation could not change.

Container

Gate only container spaces that own methods (class / struct / trait / impl / namespace / interface) — the object-oriented size metrics nom, wmc, npm, npa.

Implementations

impl MetricScope

pub fn admits(self, kind: SpaceKind) -> bool

Whether a threshold with this scope is evaluated against kind.

The single source of truth for the kind-filtering both the CLI gate and the Python binding apply, so the two cannot drift on which space kinds a metric gates.

Trait Implementations

impl Clone for MetricScope

fn clone(&self) -> MetricScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MetricScope

impl Debug for MetricScope

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

Formats the value using the given formatter.

impl Eq for MetricScope

impl Hash for MetricScope

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 MetricScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MetricScope