Struct todo_r::TodoR

pub struct TodoR { /* private fields */ }

Parser for finding TODOs in comments and storing them on a per-file basis.

Implementations

impl TodoR

pub fn new() -> TodoR

Creates new TodoR that looks for provided keywords.

pub fn with_tags<'a, I, S>(tags: I) -> TodoRwhere
    I: IntoIterator<Item = S>,
    S: Into<Cow<'a, str>>,

pub fn num_files(&self) -> usize

Returns the number of files currently tracked by TodoR

pub fn get_tracked_files<'a>(&'a self) -> Vec<&'a str>

Returns all tracked files that contain TODOs

pub fn get_all_tracked_files<'a>(&'a self) -> Vec<&'a str>

Returns all tracked files even if they have no TODOs

pub fn open_todos(&mut self, filepath: &Path) -> Result<(), Error>

Opens file at given filepath and process it by finding all its TODOs.

pub fn find_todos(&mut self, content: &str) -> Result<(), Error>

Finds TODO comments in the given content

pub fn print_todos(&self)

Prints TODOs to stdout.

pub fn write_todos(&self, out_buffer: &mut dyn Write) -> Result<(), Error>

Writes TODOs to out_buffer.

pub fn write_todos_from_file(
    &self,
    filepath: &Path,
    out_buffer: &mut dyn Write
) -> Result<(), Error>

Writes TODOs to out_buffer.

pub fn remove_todo(
    &mut self,
    filepath: &Path,
    todo_index: usize
) -> Result<(), Error>

Deletes TODO line from given filepath corresponding to the given index.

pub fn remove_todo_line(
    &mut self,
    filepath: &Path,
    line: usize
) -> Result<(), Error>

Deletes TODO line from given filepath corresponding to the given line.

Trait Implementations

impl Default for TodoR

fn default() -> TodoR

Returns the “default value” for a type.