Skip to main content

CodeMetrics

Struct CodeMetrics 

Source
pub struct CodeMetrics {
Show 13 fields pub nargs: Option<Nargs>, pub nexits: Option<Nexits>, pub cognitive: Option<Cognitive>, pub cyclomatic: Option<Cyclomatic>, pub halstead: Option<Halstead>, pub loc: Option<Loc>, pub nom: Option<Nom>, pub tokens: Option<Tokens>, pub mi: Option<Mi>, pub abc: Option<Abc>, pub wmc: Option<Wmc>, pub npm: Option<Npm>, pub npa: Option<Npa>,
}
Expand description

Wire form of crate::spaces::CodeMetrics.

Each metric is an Option skipped when None: an unselected metric (or a class-only metric flagged is_disabled) is absent from the document. On read, a present key ⇒ the metric was selected; absent ⇒ unselected. CodeMetrics::selected rebuilds the MetricSet.

Field order matches the compute type’s Serialize order exactly so the emitted record is byte-identical.

Fields§

§nargs: Option<Nargs>

NArgs metric, if selected.

§nexits: Option<Nexits>

Nexits metric, if selected.

§cognitive: Option<Cognitive>

Cognitive metric, if selected.

§cyclomatic: Option<Cyclomatic>

Cyclomatic metric, if selected.

§halstead: Option<Halstead>

Halstead metric, if selected.

§loc: Option<Loc>

Loc metric, if selected.

§nom: Option<Nom>

Nom metric, if selected.

§tokens: Option<Tokens>

Tokens metric, if selected.

§mi: Option<Mi>

Mi metric, if selected.

§abc: Option<Abc>

Abc metric, if selected.

§wmc: Option<Wmc>

Wmc metric, if selected and not disabled.

§npm: Option<Npm>

Npm metric, if selected and not disabled.

§npa: Option<Npa>

Npa metric, if selected and not disabled.

Implementations§

Source§

impl CodeMetrics

Source

pub fn selected(&self) -> MetricSet

Reconstruct the MetricSet from the metrics present on the wire.

A metric key present in the deserialized document means it was selected when the document was produced; absent means it was pruned (unselected, or a disabled class-only metric). This is the inverse of the selection eliding in From.

Trait Implementations§

Source§

impl Clone for CodeMetrics

Source§

fn clone(&self) -> CodeMetrics

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 CodeMetrics

Source§

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

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

impl Default for CodeMetrics

Source§

fn default() -> CodeMetrics

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CodeMetrics

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 From<&CodeMetrics> for CodeMetrics

Source§

fn from(c: &CodeMetrics) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for CodeMetrics

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 CodeMetrics

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

impl StructuralPartialEq for CodeMetrics

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> 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<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> 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> 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 = 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.