Skip to main content

ComplexityContribution

Struct ComplexityContribution 

Source
pub struct ComplexityContribution {
    pub line: u32,
    pub col: u32,
    pub metric: ComplexityMetric,
    pub kind: ComplexityContributionKind,
    pub weight: u16,
    pub nesting: u16,
    pub literal_membership: bool,
}
Expand description

A single complexity increment, located at its source line/column.

weight is the amount this construct added to metric; for nested cognitive increments weight == 1 + nesting. Consumers that render inline (the VS Code editor breakdown) group contributions by line and sum the weights, deferring the per-kind list to a hover.

Fields§

§line: u32

1-based line number where the construct begins.

§col: u32

0-based byte column where the construct begins.

§metric: ComplexityMetric

Which metric this increment contributes to.

§kind: ComplexityContributionKind

The syntactic construct responsible for the increment.

§weight: u16

The amount added to metric at this site (1 + nesting for nested cognitive increments, otherwise 1).

§nesting: u16

The nesting depth at the increment site (0 when not nested). Lets a consumer explain a cognitive +3 as “+1 base, +2 nesting”.

§literal_membership: bool

This cyclomatic || increment is part of a literal membership chain: strict equality checks of one identifier against primitive literals (kind === "a" || kind === "b"). The literal-membership value of health.cyclomaticPolicy removes these increments from the effective cyclomatic value. Omitted when false, and always false under the default standard policy.

Trait Implementations§

Source§

impl Clone for ComplexityContribution

Source§

fn clone(&self) -> Self

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

impl Debug for ComplexityContribution

Source§

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

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

impl<'__de> Decode<'__de> for ComplexityContribution
where '__de:,

Source§

impl<'de> Deserialize<'de> for ComplexityContribution

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 Encode for ComplexityContribution

Source§

impl Serialize for ComplexityContribution

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> DecodeOwned for T
where T: for<'de> Decode<'de>,

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.