Skip to main content

MethodMetrics

Struct MethodMetrics 

Source
pub struct MethodMetrics { /* private fields */ }
Expand description

Metrics collected for a single method in a type.

The lint driver populates this struct from HIR analysis. The CC value is the SonarSource-style cognitive complexity count; LOC is the span line count. Both values are pre-computed by the caller.

§Examples

use whitaker_common::brain_type_metrics::MethodMetrics;

let m = MethodMetrics::new("parse", 31, 140);
assert_eq!(m.name(), "parse");
assert_eq!(m.cognitive_complexity(), 31);
assert_eq!(m.lines_of_code(), 140);

Implementations§

Source§

impl MethodMetrics

Source

pub fn new( name: impl Into<String>, cognitive_complexity: usize, lines_of_code: usize, ) -> Self

Creates a new per-method metrics record.

§Examples
use whitaker_common::brain_type_metrics::MethodMetrics;

let m = MethodMetrics::new("validate", 10, 45);
assert_eq!(m.name(), "validate");
Source

pub fn name(&self) -> &str

Returns the method name.

Source

pub fn cognitive_complexity(&self) -> usize

Returns the cognitive complexity (CC) value.

Source

pub fn lines_of_code(&self) -> usize

Returns the lines of code (LOC) count.

Source

pub fn is_brain_method(&self, cc_threshold: usize, loc_threshold: usize) -> bool

Returns true when this method qualifies as a “brain method”.

A brain method has cognitive complexity >= cc_threshold and lines of code >= loc_threshold. Both conditions must hold.

§Examples
use whitaker_common::brain_type_metrics::MethodMetrics;

let m = MethodMetrics::new("parse", 30, 100);
assert!(m.is_brain_method(25, 80));
assert!(!m.is_brain_method(25, 200));

Trait Implementations§

Source§

impl Clone for MethodMetrics

Source§

fn clone(&self) -> MethodMetrics

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MethodMetrics

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for MethodMetrics

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for MethodMetrics

Source§

impl StructuralPartialEq for MethodMetrics

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.