Struct LineTypes 

pub struct LineTypes {
    pub code: bool,
    pub tests: bool,
    pub examples: bool,
    pub docs: bool,
    pub comments: bool,
    pub blanks: bool,
    pub total: bool,
}

Filter for which line types to include in results.

The 7 line types are:

• code: Production code logic lines
• tests: Test code logic lines
• examples: Example code logic lines
• docs: Documentation comments (anywhere)
• comments: Regular comments (anywhere)
• blanks: Blank lines (anywhere)
• total: Total line count (precomputed sum of all types)

When a line type is disabled, it will be zeroed in returned stats.

Fields

code: bool

Include production code logic lines

tests: bool

Include test code logic lines

examples: bool

Include example code logic lines

docs: bool

Include documentation comment lines

comments: bool

Include regular comment lines

blanks: bool

Include blank lines

total: bool

Include total line count (precomputed)

Implementations

impl LineTypes

pub fn new() -> Self

Create with no types enabled (for building up). Note: total defaults to true since it’s always useful to see totals.

pub fn everything() -> Self

Include all line types

pub fn none() -> Self

Include no line types at all (not even total)

pub fn code_only() -> Self

Include only production code (plus total)

pub fn tests_only() -> Self

Include only test code (plus total)

pub fn examples_only() -> Self

Include only example code (plus total)

pub fn logic_only() -> Self

Include all logic lines (code + tests + examples + all)

pub fn with_code(self) -> Self

Builder: enable code

pub fn with_tests(self) -> Self

Builder: enable tests

pub fn with_examples(self) -> Self

Builder: enable examples

pub fn with_docs(self) -> Self

Builder: enable docs

pub fn with_comments(self) -> Self

Builder: enable comments

pub fn with_blanks(self) -> Self

Builder: enable blanks

pub fn with_total(self) -> Self

Builder: enable total

pub fn without_total(self) -> Self

Builder: disable total

Trait Implementations

impl Clone for LineTypes

fn clone(&self) -> LineTypes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineTypes

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

Formats the value using the given formatter.

impl Default for LineTypes

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LineTypes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LineTypes

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

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

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

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

impl Serialize for LineTypes

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for LineTypes

impl Eq for LineTypes

impl StructuralPartialEq for LineTypes