Struct tokei::CodeStats

#[non_exhaustive]
pub struct CodeStats {
    pub blanks: usize,
    pub code: usize,
    pub comments: usize,
    pub blobs: BTreeMap<LanguageType, CodeStats>,
}

A struct representing stats about a single blob of code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

blanks: usize

The blank lines in the blob.

code: usize

The lines of code in the blob.

comments: usize

The lines of comments in the blob.

blobs: BTreeMap<LanguageType, CodeStats>

Language blobs that were contained inside this blob.

Implementations

impl CodeStats

pub fn new() -> Self

Creates a new blank CodeStats.

pub fn lines(&self) -> usize

Get the total lines in a blob of code.

pub fn summarise(&self) -> Self

Creates a new CodeStats from an existing one with all of the child blobs merged.

Trait Implementations

impl AddAssign<&CodeStats> for CodeStats

fn add_assign(&mut self, rhs: &CodeStats)

Performs the += operation.

impl AddAssign<CodeStats> for CodeStats

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<CodeStats> for Report

fn add_assign(&mut self, rhs: CodeStats)

Performs the += operation.

impl Clone for CodeStats

fn clone(&self) -> CodeStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeStats

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

Formats the value using the given formatter.

impl Default for CodeStats

fn default() -> CodeStats

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeStats

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<CodeStats> for CodeStats

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CodeStats

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CodeStats