Struct Summary 

pub struct Summary {
    pub total_count: usize,
    pub files_with_todos: usize,
    pub files_scanned: usize,
    pub tag_counts: HashMap<String, usize>,
}

Summary statistics from a scan

Fields

total_count: usize

Total number of TODO items found

files_with_todos: usize

Number of files containing at least one TODO

files_scanned: usize

Total number of files scanned

tag_counts: HashMap<String, usize>

Count of items per tag type

Implementations

impl Summary

pub fn avg_items_per_file(&self) -> f64

Calculate average items per file (returns 0.0 if no files with todos)

pub fn tag_percentage(&self, count: usize) -> f64

Calculate percentage for a given tag count

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Summary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Summary

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Summary