Skip to main content

ProjectMetrics

Struct ProjectMetrics 

Source
pub struct ProjectMetrics {
    pub modules: HashMap<String, ModuleMetrics>,
    pub couplings: Vec<CouplingMetrics>,
    pub file_changes: HashMap<String, usize>,
    pub total_files: usize,
    pub workspace_name: Option<String>,
    pub workspace_members: Vec<String>,
    pub crate_dependencies: HashMap<String, Vec<String>>,
    pub type_registry: HashMap<String, (String, Visibility)>,
    pub temporal_couplings: Vec<TemporalCoupling>,
}
Expand description

Project-wide analysis results

Fields§

§modules: HashMap<String, ModuleMetrics>

All module metrics

§couplings: Vec<CouplingMetrics>

All detected couplings

§file_changes: HashMap<String, usize>

File change counts (for volatility)

§total_files: usize

Total files analyzed

§workspace_name: Option<String>

Workspace name (if available from cargo metadata)

§workspace_members: Vec<String>

Workspace member crate names

§crate_dependencies: HashMap<String, Vec<String>>

Crate-level dependencies (crate name -> list of dependencies)

§type_registry: HashMap<String, (String, Visibility)>

Global type registry: type name -> (module name, visibility)

§temporal_couplings: Vec<TemporalCoupling>

Temporal coupling data (files that co-change frequently)

Implementations§

Source§

impl ProjectMetrics

Source

pub fn new() -> Self

Source

pub fn add_module(&mut self, metrics: ModuleMetrics)

Add module metrics

Source

pub fn add_coupling(&mut self, coupling: CouplingMetrics)

Add coupling

Source

pub fn register_type( &mut self, type_name: String, module_name: String, visibility: Visibility, )

Register a type definition in the global registry

Source

pub fn get_type_visibility(&self, type_name: &str) -> Option<Visibility>

Look up visibility of a type by name

Source

pub fn get_type_module(&self, type_name: &str) -> Option<&str>

Look up the module where a type is defined

Source

pub fn update_coupling_visibility(&mut self)

Update visibility information for existing couplings

This should be called after all modules have been analyzed to populate the target_visibility field of couplings.

Source

pub fn module_count(&self) -> usize

Get total module count

Source

pub fn coupling_count(&self) -> usize

Get total coupling count

Source

pub fn internal_coupling_count(&self) -> usize

Get internal coupling count (excludes external crate dependencies)

Source

pub fn average_strength(&self) -> Option<f64>

Calculate average strength across all couplings

Source

pub fn average_distance(&self) -> Option<f64>

Calculate average distance across all couplings

Source

pub fn update_volatility_from_git(&mut self)

Update volatility for all couplings based on file changes

This should be called after git history analysis to update the volatility of each coupling based on how often the target module/file has changed.

Source

pub fn detect_circular_dependencies(&self) -> Vec<Vec<String>>

Detect circular dependencies in the project

Returns a list of cycles, where each cycle is a list of module names forming the circular dependency chain.

Source

pub fn circular_dependency_summary(&self) -> CircularDependencySummary

Get circular dependency summary

Source

pub fn calculate_dimension_stats(&self) -> DimensionStats

Calculate 3-dimensional coupling statistics

Computes distribution of couplings across Strength, Distance, Volatility, and Balance Classification dimensions.

Source

pub fn total_newtype_count(&self) -> usize

Get total newtype count across all modules

Source

pub fn total_type_count(&self) -> usize

Get total type count across all modules (excluding traits)

Source

pub fn newtype_ratio(&self) -> f64

Calculate project-wide newtype usage ratio

Source

pub fn serde_types(&self) -> Vec<(&str, &TypeDefinition)>

Get types with serde derives (potential DTO exposure)

Source

pub fn god_modules( &self, max_functions: usize, max_types: usize, max_impls: usize, ) -> Vec<&str>

Identify potential God Modules

Source

pub fn functions_with_primitive_obsession( &self, ) -> Vec<(&str, &FunctionDefinition)>

Get all functions with potential Primitive Obsession

Source

pub fn types_with_public_fields(&self) -> Vec<(&str, &TypeDefinition)>

Get types with exposed public fields

Trait Implementations§

Source§

impl Debug for ProjectMetrics

Source§

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

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

impl Default for ProjectMetrics

Source§

fn default() -> ProjectMetrics

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,