Struct ScanResult 

pub struct ScanResult {
    pub files: Option<Vec<FileResult>>,
    pub files_map: HashMap<PathBuf, Vec<TodoItem>>,
    pub summary: Summary,
    pub root: Option<PathBuf>,
}

Result of scanning a directory for TODO items

Fields

files: Option<Vec<FileResult>>

List of files containing TODO items (for JSON output)

files_map: HashMap<PathBuf, Vec<TodoItem>>

Map of file paths to their TODO items (for internal use)

summary: Summary

Summary statistics

root: Option<PathBuf>

Root directory that was scanned

Implementations

impl ScanResult

pub fn new(root: PathBuf) -> ScanResult

Create a new empty scan result

pub fn from_json(files: Vec<FileResult>, summary: Summary) -> ScanResult

Create a scan result from JSON-style data

pub fn is_empty(&self) -> bool

Check if the scan found any TODO items

pub fn add_file(&mut self, path: PathBuf, items: Vec<TodoItem>)

Add TODO items for a file

pub fn all_items(&self) -> Vec<(PathBuf, TodoItem)>

Get all TODO items as a flat list

pub fn sorted_files(&self) -> Vec<(&PathBuf, &Vec<TodoItem>)>

Get files sorted by path

pub fn filter_by_tag(&self, tag: &str) -> ScanResult

Filter items by tag

pub fn to_json_format(&self) -> ScanResult

Convert to JSON-friendly format with FileResult list

pub fn get_files(&self) -> Vec<FileResult>

Get files from either format

Trait Implementations

impl Clone for ScanResult

fn clone(&self) -> ScanResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScanResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScanResult

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.