Struct ComplexityContribution 

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,
}

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

impl Clone for ComplexityContribution

fn clone(&self) -> ComplexityContribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComplexityContribution

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

Formats the value using the given formatter.

impl<'__de> Decode<'__de> for ComplexityContribution

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ComplexityContribution

impl JsonSchema for ComplexityContribution

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ComplexityContribution

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.