Struct Config 

pub struct Config {
    pub tags: Vec<String>,
    pub include: Vec<String>,
    pub exclude: Vec<String>,
    pub json: bool,
    pub flat: bool,
    pub no_color: bool,
    pub custom_pattern: Option<String>,
    pub ignore_case: bool,
    pub require_colon: bool,
}

A loaded (or default) .todorc configuration.

Fields

tags: Vec<String>

Tags to search for.

include: Vec<String>

Glob patterns to include.

exclude: Vec<String>

Glob patterns to exclude.

json: bool

Whether to default to JSON output.

flat: bool

Whether to default to flat output.

no_color: bool

Whether to default to uncolored output.

custom_pattern: Option<String>

An optional custom tag-matching regex, in place of crate::parser::DEFAULT_REGEX.

ignore_case: bool

Whether tag matching is case-insensitive.

require_colon: bool

Whether a trailing colon is required after the tag.

Implementations

impl Config

pub fn new() -> Self

Builds a config with the default tag set and strict matching (case-sensitive, colon required).

pub fn load(start_path: &Path) -> Result<Option<Self>>

Load configuration from a .todorc file

Searches for configuration files in the following order:

1. .todorc in the current directory
2. .todorc.json in the current directory
3. .todorc.toml in the current directory
4. Parent directories (recursive)
5. $XDG_CONFIG_HOME/todo-tree/config.json or config.toml, falling back to the platform config directory if XDG_CONFIG_HOME isn’t set (global config)

pub fn load_from_file(path: &Path) -> Result<Self>

Loads and parses a specific config file, auto-detecting JSON vs. TOML from its extension (falling back to JSON-then-TOML for extensionless files like .todorc).

pub fn merge_with_cli(&mut self, cli: CliOptions)

Merges CLI-provided overrides into this config in place.

pub fn load_or_default(path: &Path, config_path: Option<&Path>) -> Result<Self>

Loads a config, honoring an explicit config_path override before falling back to Config::load’s discovery starting at path, and finally to Config::new if nothing is found anywhere. TODO_TREE_* environment variables (see Config::apply_env_overrides) are then layered on top, so the full precedence is: CLI flags (applied by the caller via Config::merge_with_cli) > environment > project/user config file > built-in defaults.

pub fn save_in_cwd(&self) -> Result<()>

Saves this config to whichever .todorc/.todorc.json/.todorc.toml already exists in the current directory, or .todorc.json if none do.

pub fn save(&self, path: &Path) -> Result<()>

Writes this config to path, choosing TOML or JSON based on its extension (JSON if unrecognized).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.