Struct Stats 

#[non_exhaustive]
pub struct Stats { /* private fields */ }

The Cognitive Complexity metric.

Implementations

impl Stats

pub fn merge(&mut self, other: &Stats)

Merges a second Cognitive Complexity metric into the first one

pub fn cognitive(&self) -> u64

Returns the Cognitive Complexity metric value

pub fn cognitive_sum(&self) -> u64

Returns the Cognitive Complexity sum metric value

pub fn cognitive_min(&self) -> u64

Returns the Cognitive Complexity minimum metric value.

Collapses the usize::MAX sentinel that Stats::default() plants into structural_min to 0, so a never-observed space serializes to a meaningful number rather than 1.8446744e19.

pub fn cognitive_max(&self) -> u64

Returns the Cognitive Complexity maximum metric value

pub fn cognitive_average(&self) -> f64

Returns the Cognitive Complexity metric average value

This value is computed dividing the Cognitive Complexity value for the total number of functions/closures in a space.

The per-function divisor (shared with cyclomatic/exit/nargs, #512) is guarded with .max(1) via the shared average helper, so a space with no counted functions (or one where Nom was not selected) degrades to sum / 1 instead of producing inf/NaN (#428).

Trait Implementations

impl Clone for Stats

fn clone(&self) -> Stats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

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

Formats the value using the given formatter.

impl Default for Stats

fn default() -> Self

Returns the “default value” for a type.

impl Display for Stats

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

Formats the value using the given formatter.

impl From<&Stats> for Cognitive

fn from(s: &Stats) -> Self

Converts to this type from the input type.

impl PartialEq for Stats

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Stats