Struct Locs 

pub struct Locs {
    pub code: u64,
    pub tests: u64,
    pub examples: u64,
    pub docs: u64,
    pub comments: u64,
    pub blanks: u64,
    pub total: u64,
}

Lines of code counts with 7 line types.

This is the fundamental unit of measurement in rustloc. Each field counts a specific type of line:

• code, tests, examples: Actual executable/logic lines, distinguished by context
• docs, comments, blanks: Metadata lines, counted regardless of location
• total: Precomputed sum of all line types (total line count)

Fields

code: u64

Logic lines in production code (src/, not in test blocks)

tests: u64

Logic lines in test code (#test, #[cfg(test)], tests/ directory)

examples: u64

Logic lines in example code (examples/ directory)

docs: u64

Documentation comment lines (///, //!, /** /, /! */)

comments: u64

Regular comment lines (//, /* */)

blanks: u64

Blank lines (whitespace only)

total: u64

Total line count (sum of all types)

Implementations

impl Locs

pub fn new() -> Self

Create a new Locs with all zeros.

pub fn total(&self) -> u64

Total lines (returns precomputed total field).

pub fn total_logic(&self) -> u64

Total logic lines (code + tests + examples).

pub fn recompute_total(&mut self)

Recompute the total field from individual line types. Call this after manually setting individual fields.

pub fn filter(&self, types: LineTypes) -> Self

Return a filtered copy with only the specified line types included. Unselected types are zeroed out. The total field is always preserved.

Trait Implementations

impl Add for Locs

type Output = Locs

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign for Locs

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Locs

fn clone(&self) -> Locs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Locs

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

Formats the value using the given formatter.

impl Default for Locs

fn default() -> Locs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Locs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Locs

fn eq(&self, other: &Locs) -> 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 Locs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Locs

type Output = Locs

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign for Locs

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Locs

impl Eq for Locs

impl StructuralPartialEq for Locs