ComplexityMetrics

scribe_analysis::complexity

Struct ComplexityMetrics

pub struct ComplexityMetrics {Show 13 fields
    pub cyclomatic_complexity: usize,
    pub max_nesting_depth: usize,
    pub function_count: usize,
    pub logical_lines: usize,
    pub comment_lines: usize,
    pub blank_lines: usize,
    pub total_lines: usize,
    pub cognitive_complexity: usize,
    pub maintainability_index: f64,
    pub average_function_length: f64,
    pub code_density: f64,
    pub comment_ratio: f64,
    pub language_metrics: LanguageSpecificMetrics,
}

Expand description

Comprehensive complexity metrics for a code file

Fields§

§cyclomatic_complexity: usize

Cyclomatic complexity (McCabe complexity)

§max_nesting_depth: usize

Maximum nesting depth

§function_count: usize

Total number of functions/methods

§logical_lines: usize

Number of logical lines of code (excluding comments and blanks)

§comment_lines: usize

Number of comment lines

§blank_lines: usize

Number of blank lines

§total_lines: usize

Total physical lines

§cognitive_complexity: usize

Cognitive complexity (easier to understand than cyclomatic)

§maintainability_index: f64

Maintainability index (0-100, higher is better)

§average_function_length: f64

Average function length

§code_density: f64

Code density (logical lines / total lines)

§comment_ratio: f64

Comment ratio (comment lines / logical lines)

§language_metrics: LanguageSpecificMetrics

Language-specific metrics

Implementations§

impl ComplexityMetrics

pub fn complexity_score(&self) -> f64

Get a complexity score (0-1, where higher means more complex)

pub fn exceeds_thresholds( &self, thresholds: &ComplexityThresholds, ) -> Vec<String>

Check if any complexity thresholds are exceeded

pub fn summary(&self) -> String

Get a human-readable summary

Trait Implementations§

impl Clone for ComplexityMetrics

fn clone(&self) -> ComplexityMetrics

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

impl Debug for ComplexityMetrics

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ComplexityMetrics

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for ComplexityMetrics

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for ComplexityMetrics

impl RefUnwindSafe for ComplexityMetrics

impl Send for ComplexityMetrics

impl Sync for ComplexityMetrics

impl Unpin for ComplexityMetrics

impl UnwindSafe for ComplexityMetrics

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,