FileDebtMetrics

Struct FileDebtMetrics 

Source
pub struct FileDebtMetrics {
Show 13 fields pub path: PathBuf, pub total_lines: usize, pub function_count: usize, pub class_count: usize, pub avg_complexity: f64, pub max_complexity: u32, pub total_complexity: u32, pub coverage_percent: f64, pub uncovered_lines: usize, pub god_object_indicators: GodObjectIndicators, pub function_scores: Vec<f64>, pub god_object_type: Option<GodObjectType>, pub file_type: Option<FileType>,
}

Fields§

§path: PathBuf§total_lines: usize§function_count: usize§class_count: usize§avg_complexity: f64§max_complexity: u32§total_complexity: u32§coverage_percent: f64§uncovered_lines: usize§god_object_indicators: GodObjectIndicators§function_scores: Vec<f64>§god_object_type: Option<GodObjectType>

The specific type of god object detected (if any).

This field contains the classification of god object patterns:

  • GodModule: A module with too many related structs/types that should be split
  • TraditionalGodObject: A single class/struct with too many responsibilities
  • Boilerplate: Repetitive code that should be macro-ified (NOT a god object)
  • Registry: A lookup table or mapping structure (NOT a god object)

This type is used to determine the appropriate recommendation, following this precedence:

  1. Boilerplate → recommend macros/codegen
  2. Registry → recommend keeping as-is or data-driven approach
  3. TraditionalGodObject → recommend extracting classes/modules
  4. GodModule → recommend splitting into multiple modules
  5. None → use general refactoring recommendations based on size/complexity
§file_type: Option<FileType>

File type classification for context-aware thresholds (spec 135)

Implementations§

Source§

impl FileDebtMetrics

Source

pub fn calculate_score(&self) -> f64

Source

pub fn get_score_factors(&self) -> FileScoreFactors

Extract individual scoring factors for display purposes.

This method decomposes the opaque score calculation from calculate_score() into individual factors that can be shown to users for transparency.

§Returns

FileScoreFactors containing:

  • All 6 multiplicative factors (size, complexity, coverage, density, god object, function)
  • Basis values used to calculate each factor
  • Contextual information for display (e.g., whether flagged as god object)
§Example
let mut metrics = FileDebtMetrics::default();
metrics.total_lines = 400;
metrics.coverage_percent = 0.75;
let factors = metrics.get_score_factors();
println!("Coverage factor: {:.2} ({:.0}% coverage)",
         factors.coverage_factor,
         factors.coverage_percent * 100.0);
Source

pub fn generate_recommendation(&self) -> String

Generate a recommendation for addressing this file’s technical debt.

This function uses a precedence-based strategy to select the most appropriate recommendation type, checking patterns in this order:

  1. Boilerplate Pattern (highest priority)

    • Detected when file has many repetitive trait implementations
    • Recommendation: Use macros or code generation to reduce repetition
    • Example: ripgrep’s flags/defs.rs with 888 Flag trait implementations
  2. Registry Pattern

    • Detected when file is primarily a lookup table or data mapping
    • Recommendation: Keep as-is or convert to data-driven approach
    • Example: Error code registries, configuration tables
  3. God Object

    • Detected when file has too many responsibilities (via god_object_indicators)
    • Recommendation: Split into multiple focused modules
    • Context-specific advice based on file type (parser, cache, analyzer, etc.)
  4. Large File (>500 lines)

    • Recommendation: Extract complex functions to reduce size
  5. Complex Functions (avg complexity >10)

    • Recommendation: Simplify logic, extract helper functions
  6. Low Coverage (<50%)

    • Recommendation: Add tests for uncovered code

The precedence ensures that boilerplate files don’t get incorrectly flagged as god objects requiring module splitting.

Trait Implementations§

Source§

impl Clone for FileDebtMetrics

Source§

fn clone(&self) -> FileDebtMetrics

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 FileDebtMetrics

Source§

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

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

impl Default for FileDebtMetrics

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for FileDebtMetrics

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FileDebtMetrics

Source§

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§

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> 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, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

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, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
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.
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U

Source§

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