Struct Stats 

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) -> f64

Returns the Cognitive Complexity metric value

pub fn cognitive_sum(&self) -> f64

Returns the Cognitive Complexity sum metric value

pub fn cognitive_min(&self) -> f64

Returns the Cognitive Complexity minimum metric value

pub fn cognitive_max(&self) -> f64

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.

If there are no functions in a code, its value is NAN.

pub fn max_nesting(&self) -> f64

Returns the maximum control-flow nesting depth reached in this space.

Counted as the deepest level of nested branching/looping constructs (e.g. three nested ifs yield 3); 0 when the space contains no such construct. Derived from the same nesting the cognitive pass already tracks.

pub fn total_nesting(&self) -> f64

Returns the sum of the nesting depth of every branching/looping construct in this space.

pub fn bool_ops(&self) -> f64

Returns the number of boolean-operator sequences in this space.

A run of the same operator (a && b && c) counts once; switching operators (a && b || c) starts a new sequence. This is the same boolean-sequence accounting the cognitive metric folds into its score.

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 Serialize for Stats

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

where S: Serializer,

Serialize this value into the given Serde serializer.