Struct TodoParser 

pub struct TodoParser { /* private fields */ }

Parser for detecting TODO-style tags in source code

Implementations

impl TodoParser

pub fn new(tags: &[String], case_sensitive: bool) -> Self

Create a new parser with the given tags

pub fn with_regex( tags: &[String], case_sensitive: bool, custom_regex: Option<&str>, ) -> Self

Create a new parser with a custom regex pattern

The pattern should contain $TAGS as a placeholder which will be replaced with the alternation of escaped tags (e.g., TODO|FIXME|BUG).

If no custom pattern is provided, the default pattern is used.

pub fn pattern_string(&self) -> Option<&str>

Get the regex pattern string for ripgrep integration

pub fn parse_line(&self, line: &str, line_number: usize) -> Option<TodoItem>

Parse a single line for TODO items

pub fn parse_content(&self, content: &str) -> Vec<TodoItem>

Parse content (multiple lines) for TODO items

pub fn parse_file(&self, path: &Path) -> Result<Vec<TodoItem>>

Parse a file for TODO items

pub fn tags(&self) -> &[String]

Get the tags being searched for

Trait Implementations

impl Clone for TodoParser

fn clone(&self) -> TodoParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TodoParser

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

Formats the value using the given formatter.