Skip to main content

AnalysisName

codelore_lib::analysis

Enum AnalysisName

pub enum AnalysisName {
Show 57 variants    Hotspots,
    HotspotVelocity,
    Coupling,
    Ownership,
    CodeAge,
    AbsChurn,
    AuthorChurn,
    EntityChurn,
    Communication,
    CodeHealth,
    Summary,
    Revisions,
    Authors,
    Clones,
    CloneCoupling,
    Soc,
    Messages,
    MainDev,
    MainDevByRevs,
    MainDevByDeletions,
    EntityEffort,
    EntityOwnership,
    TopCommitters,
    KnowledgeIslands,
    Centrality,
    Communities,
    GodClasses,
    ArchViolations,
    DependencyCycles,
    ArchitectureRoles,
    Instability,
    ArchitectureMetrics,
    ArchitectureTrend,
    HealthTrend,
    CycleOrigins,
    ModularityViolations,
    UnstableInterface,
    Crossing,
    StaleCode,
    PairProgramming,
    LeadTime,
    BusFactor,
    DeliveryFriction,
    DeliveryMetrics,
    RefactoringTargets,
    EffortExposure,
    CodeFamiliarity,
    TeamComposition,
    CoordinationNeeds,
    MarginalOwnerRisk,
    ReleaseCadence,
    FunctionXray,
    FunctionHotspots,
    FunctionCoupling,
    FindingHotspotOverlap,
    CycleHealth,
    DefectValidation,
}

Variants§

Hotspots

HotspotVelocity

Coupling

Ownership

CodeAge

AbsChurn

AuthorChurn

EntityChurn

Communication

CodeHealth

Summary

Revisions

Authors

Clones

CloneCoupling

Soc

Messages

MainDev

MainDevByRevs

MainDevByDeletions

EntityEffort

EntityOwnership

TopCommitters

KnowledgeIslands

Centrality

Communities

GodClasses

ArchViolations

DependencyCycles

ArchitectureRoles

Instability

ArchitectureMetrics

ArchitectureTrend

HealthTrend

CycleOrigins

ModularityViolations

UnstableInterface

Crossing

StaleCode

PairProgramming

LeadTime

BusFactor

DeliveryFriction

DeliveryMetrics

RefactoringTargets

EffortExposure

CodeFamiliarity

TeamComposition

CoordinationNeeds

MarginalOwnerRisk

ReleaseCadence

FunctionXray

FunctionHotspots

FunctionCoupling

FindingHotspotOverlap

CycleHealth

DefectValidation

Implementations§

impl AnalysisName

pub fn as_str(self) -> &'static str

pub fn all() -> &'static [Self]

pub fn supports_time_bucket(&self) -> bool

Classify which analyses can run under --time-bucket. The bucketed source table (changes_bucketed) is materialised by lineage::materialize_source and synthesises rev as a date-truncated string. Any analysis that JOINs c.rev = commits.rev against the non-bucketed commits table silently returns zero rows. Any analysis that uses materialize_if_needed (no-op on the bucketed branch) crashes with Catalog Error: Table changes_bucketed does not exist. Both failure modes are unacceptable user experiences.

Currently only coupling, soc, hotspots, and code-health invoke materialize_source AND have SQL that doesn’t depend on the commits JOIN for rev equality. These four are the only analyses that semantically MAKE SENSE under bucketing (they’re all about co-change, which --time-bucket is designed to smooth). The other 50 are either per-file or per-author aggregations where bucketing is semantically a no-op or outright invalid.

Adding a new analysis: opt INTO bucketing by adding the variant to this match arm AND wiring materialize_source (not materialize_if_needed) in the analysis’s run_* function.

Trait Implementations§

impl Clone for AnalysisName

fn clone(&self) -> AnalysisName

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for AnalysisName

impl Debug for AnalysisName

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

Formats the value using the given formatter. Read more

impl Display for AnalysisName

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

Formats the value using the given formatter. Read more

impl Eq for AnalysisName

impl FromStr for AnalysisName

type Err = UnknownAnalysisError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

impl Hash for AnalysisName

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for AnalysisName

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for AnalysisName

Auto Trait Implementations§

impl Freeze for AnalysisName

impl RefUnwindSafe for AnalysisName

impl Send for AnalysisName

impl Sync for AnalysisName

impl Unpin for AnalysisName

impl UnsafeUnpin for AnalysisName

impl UnwindSafe for AnalysisName

Blanket Implementations§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

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

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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