Struct ScoreComponents

Source

pub struct ScoreComponents {
    pub doc_score: f64,
    pub readme_score: f64,
    pub import_score: f64,
    pub path_score: f64,
    pub test_link_score: f64,
    pub churn_score: f64,
    pub final_score: f64,
    pub centrality_score: f64,
    pub entrypoint_score: f64,
    pub examples_score: f64,
}

Expand description

Individual components of the heuristic scoring system

Fields§

§doc_score: f64

Documentation score (presence of comments, docstrings)

§readme_score: f64

README/documentation file score

§import_score: f64

Import/dependency score (how much this file is imported)

§path_score: f64

Path depth score (penalize deeply nested files)

§test_link_score: f64

Test linkage score (proximity to tests)

§churn_score: f64

Code churn score (git activity)

§final_score: f64

Final weighted score

§centrality_score: f64

PageRank centrality score

§entrypoint_score: f64

Entrypoint detection score

§examples_score: f64

Examples/usage score

Implementations§

Source §

impl ScoreComponents

Source

pub fn zero() -> ScoreComponents

Create a new ScoreComponents with all scores at zero

Source

pub fn compute_final_score(&mut self, weights: &HeuristicWeights)

Compute final score using provided weights

Source

pub fn breakdown(&self, weights: &HeuristicWeights) -> Vec<(String, f64, f64)>

Get a breakdown of score contributions

Trait Implementations§

Source §

impl Clone for ScoreComponents

Source §

fn clone(&self) -> ScoreComponents

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 ScoreComponents

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for ScoreComponents

Source §

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

Deserialize this value from the given Serde deserializer. Read more

Source §

impl PartialEq for ScoreComponents

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl Serialize for ScoreComponents

Source §

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

Serialize this value into the given Serde serializer. Read more

Source §

impl StructuralPartialEq for ScoreComponents

Auto Trait Implementations§

§

impl UnwindSafe for ScoreComponents

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