Struct TodoParser 

pub struct TodoParser { /* private fields */ }

Parses TODO-style tags out of file content using a configurable regex.

Implementations

impl TodoParser

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

Creates a parser for tags, requiring an exact-case match and a trailing colon, using the default comment-marker regex.

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

Creates a parser with full control over case sensitivity, whether a trailing colon is required, and an optional custom regex (in place of DEFAULT_REGEX).

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

Parses a single line, returning the matched item if the line contains one of the parser’s tags.

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

Parses every line of content, returning all matched items in order.

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

Reads path and parses its contents.

Before paying for UTF-8 validation and a regex pass, this does a cheap memchr-based byte scan for any of the configured tags. Files that can’t possibly match (lockfiles, bundled JS, binaries) are skipped without ever being validated as UTF-8.

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

The tags this parser was configured with.

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.