Struct todo_r::TodoRBuilder

pub struct TodoRBuilder { /* private fields */ }

A builder to create a TodoR with a custom configuration. Customization occurs in two forms: using manual functions and adding config files.

Functions

Use functions such as add_tag() to add to the config. Functions that have override in them will fully override settings from config files.

Config files

Config files are added using add_config_file().

For an example config file, use todo_r::write_example_config().

Implementations

impl TodoRBuilder

pub fn new() -> TodoRBuilder

Creates TodoRBuilder using the default configuration.

pub fn with_no_config() -> TodoRBuilder

Creates TodoRBuilder with no configuration.

pub fn build(self) -> Result<TodoR, Error>

Consumes self and builds TodoR.

pub fn add_config_file(&mut self, config_path: &Path) -> Result<&mut Self, Error>

Adds config file for TodoR.

pub fn add_tag<'a, S: Into<Cow<'a, str>>>(&mut self, tag: S) -> &mut Self

Adds tag for TodoR to look for without overriding tags from config files.

pub fn add_tags<'a, I, S>(&mut self, tags: I) -> &mut Selfwhere
    I: IntoIterator<Item = S>,
    S: Into<Cow<'a, str>>,

Adds tags for TodoR to look for without overriding tags from config files.

pub fn add_override_tag<'a, S: Into<Cow<'a, str>>>(
    &mut self,
    tag: S
) -> &mut Self

Adds tag for TodoR to look for. This overrides tags from config files.

pub fn add_override_tags<'a, I, S>(&mut self, tags: I) -> &mut Selfwhere
    I: IntoIterator<Item = S>,
    S: Into<Cow<'a, str>>,

Adds tags for TodoR to look for. This overrides tags from config files.

pub fn set_verbose(&mut self, verbose: bool) -> &mut Self

Overrides verbose from config files.

pub fn set_no_style(&mut self) -> &mut Self

Sets the terminal output of TodoR to be with no styles.

pub fn add_override_ignore_path(
    &mut self,
    path: &str
) -> Result<&mut Self, Error>

Adds path for TodoR to ignore. This overrides ignore paths from config files.

pub fn add_override_ignore_paths<I, S>(
    &mut self,
    paths: I
) -> Result<&mut Self, Error>where
    I: IntoIterator<Item = S>,
    S: AsRef<str>,

Adds paths for TodoR to ignore. This overrides ignore paths from config files.

pub fn set_default_ext<'a, S: Into<Cow<'a, str>>>(
    &mut self,
    ext: S
) -> Result<(), Error>

Sets the default fall-back extension for comments.

For instance if you want to parse unknown extensions using C style comments, use builder.set_default_ext("c").

Trait Implementations

impl Clone for TodoRBuilder

fn clone(&self) -> TodoRBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TodoRBuilder

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

Formats the value using the given formatter.

impl Default for TodoRBuilder

fn default() -> TodoRBuilder

Returns the “default value” for a type.