Struct tokei::Stats

pub struct Stats {
    pub blanks: usize,
    pub code: usize,
    pub comments: usize,
    pub lines: usize,
    pub name: PathBuf,
}

A struct representing the statistics of a file.

Fields

blanks: usize

Number of blank lines within the file.

code: usize

Number of lines of code within the file.

comments: usize

Number of comments within the file. (includes both multi line, and single line comments)

lines: usize

Total number of lines within the file.

name: PathBuf

File name.

Methods

impl Stats

fn new(name: PathBuf) -> Self

Create a new Stats from a file path.

use std::path::PathBuf;
use tokei::Stats;

let path = PathBuf::from("src/main.rs");

let stats = Stats::new(path);

Trait Implementations

impl Clone for Stats

fn clone(&self) -> Stats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Stats

impl Ord for Stats

fn cmp(&self, __arg_0: &Stats) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq for Stats

fn eq(&self, __arg_0: &Stats) -> bool

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

fn ne(&self, __arg_0: &Stats) -> bool

This method tests for !=.

impl PartialOrd for Stats

fn partial_cmp(&self, __arg_0: &Stats) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Stats) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Stats) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Stats) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Stats) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Default for Stats

fn default() -> Self

Returns the "default value" for a type.

impl Display for Stats

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

Formats the value using the given formatter.