Skip to main content

ComplexityReport

tokmd_analysis_types

Struct ComplexityReport

pub struct ComplexityReport {Show 15 fields
    pub total_functions: usize,
    pub avg_function_length: f64,
    pub max_function_length: usize,
    pub avg_cyclomatic: f64,
    pub max_cyclomatic: usize,
    pub avg_cognitive: Option<f64>,
    pub max_cognitive: Option<usize>,
    pub avg_nesting_depth: Option<f64>,
    pub max_nesting_depth: Option<usize>,
    pub high_risk_files: usize,
    pub histogram: Option<ComplexityHistogram>,
    pub halstead: Option<HalsteadMetrics>,
    pub maintainability_index: Option<MaintainabilityIndex>,
    pub technical_debt: Option<TechnicalDebtRatio>,
    pub files: Vec<FileComplexity>,
}

Fields§

§total_functions: usize§avg_function_length: f64§max_function_length: usize§avg_cyclomatic: f64§max_cyclomatic: usize§avg_cognitive: Option<f64>

Average cognitive complexity across files.

§max_cognitive: Option<usize>

Maximum cognitive complexity found.

§avg_nesting_depth: Option<f64>

Average nesting depth across files.

§max_nesting_depth: Option<usize>

Maximum nesting depth found.

§high_risk_files: usize§histogram: Option<ComplexityHistogram>

Histogram of cyclomatic complexity distribution.

§halstead: Option<HalsteadMetrics>

Halstead software science metrics (requires halstead feature).

§maintainability_index: Option<MaintainabilityIndex>

Composite maintainability index.

§technical_debt: Option<TechnicalDebtRatio>

Complexity-to-size debt heuristic.

§files: Vec<FileComplexity>

Trait Implementations§

impl Clone for ComplexityReport

fn clone(&self) -> ComplexityReport

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 ComplexityReport

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ComplexityReport

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 ComplexityReport

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 ComplexityReport

impl RefUnwindSafe for ComplexityReport

impl Send for ComplexityReport

impl Sync for ComplexityReport

impl Unpin for ComplexityReport

impl UnsafeUnpin for ComplexityReport

impl UnwindSafe for ComplexityReport

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> 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>,