Enum MetricKind 

pub enum MetricKind {
    Cognitive,
    Cyclomatic,
    Halstead,
    Loc,
    Mi,
    Nargs,
    Nom,
    Npa,
    Npm,
    Abc,
    Exit,
    Wmc,
}

Stable metric identifier set that suppression markers can name.

Names match the JSON field names emitted on crate::CodeMetrics (and on the per-metric bca threshold registry). Unknown identifiers in a bca: suppress(...) list produce a hard error so a typo cannot silently widen suppression scope to other metrics or be dropped on the floor.

Variants

Cognitive

Cognitive complexity.

Cyclomatic

Cyclomatic complexity (both standard and modified variants).

Halstead

Halstead suite.

Loc

Lines-of-code suite (sloc, ploc, lloc, cloc, blank).

Mi

Maintainability Index suite.

Nargs

Number of arguments.

Nom

Number of methods / functions.

Npa

Number of public attributes.

Npm

Number of public methods.

Abc

ABC (assignments, branches, conditions) magnitude.

Exit

Number of exit points.

Wmc

Weighted methods per class.

Implementations

impl MetricKind

pub const ALL: &'static [Self]

Every MetricKind variant, in alphabetical order. Used to render the “known metrics:” hint in error messages; the test metric_kind_all_is_alphabetical locks the order so the hint stays predictable across releases.

pub fn for_threshold_name(name: &str) -> Option<Self>

Resolve a sub-metric threshold name (e.g. cyclomatic.modified, halstead.volume, loc.lloc) to its parent MetricKind.

The threshold engine uses dotted forms to address individual sub-metrics, but suppression markers only know about the top-level metric family — silencing halstead silences all of halstead.volume, halstead.effort, etc. This translation happens here so the threshold-check loop can ask one question (“does this scope cover this metric family?”) instead of special-casing each dotted name.

pub const fn as_str(self) -> &'static str

Canonical string form. Round-trips through FromStr.

Trait Implementations

impl Clone for MetricKind

fn clone(&self) -> MetricKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricKind

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

Formats the value using the given formatter.

impl Display for MetricKind

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

Formats the value using the given formatter.

impl FromStr for MetricKind

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MetricKind

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 Ord for MetricKind

fn cmp(&self, other: &MetricKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MetricKind

fn eq(&self, other: &MetricKind) -> 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 PartialOrd for MetricKind

fn partial_cmp(&self, other: &MetricKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetricKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MetricKind

impl Eq for MetricKind

impl StructuralPartialEq for MetricKind