Struct Config 

pub struct Config {
    pub defaults: DefaultsConfig,
    pub paths: PathsConfig,
}

Global configuration for the blz cache system.

Contains default settings that apply to all sources unless overridden by per-source configuration. Configuration is automatically loaded from the system config directory or created with sensible defaults.

File Location

The configuration file is stored at (searched in order):

• XDG: $XDG_CONFIG_HOME/blz/config.toml or ~/.config/blz/config.toml
• Dotfile fallback: ~/.blz/config.toml

A config.local.toml in the same directory overrides keys from config.toml.

Example Configuration File

[defaults]
refresh_hours = 24
max_archives = 10
fetch_enabled = true
follow_links = "first_party"
allowlist = ["docs.rs", "developer.mozilla.org"]

[paths]
root = "/home/user/.outfitter/blz"

Fields

defaults: DefaultsConfig

Default settings for all sources

paths: PathsConfig

File system paths configuration

Implementations

impl Config

pub fn load() -> Result<Self>

Load configuration from the default location or create with defaults.

This method attempts to load the configuration from the system config directory. If the file doesn’t exist, it returns a configuration with sensible defaults. If the file exists but is malformed, it returns an error.

Returns

Returns the loaded configuration or a default configuration if no file exists.

Errors

Returns an error if:

• The config directory cannot be determined (unsupported platform)
• The config file exists but cannot be read (permissions, I/O error)
• The config file exists but contains invalid TOML syntax
• The config file exists but contains invalid configuration values

Examples

use blz_core::Config;

// Load existing config or create with defaults
let config = Config::load()?;

if config.defaults.fetch_enabled {
    println!("Fetching is enabled");
}

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

Save the configuration to the default location.

This method serializes the configuration to TOML format and writes it to the system config directory. Parent directories are created if they don’t exist.

Errors

Returns an error if:

• The config directory cannot be determined (unsupported platform)
• Parent directories cannot be created (permissions, disk space)
• The configuration cannot be serialized to TOML
• The file cannot be written (permissions, disk space, I/O error)

Examples

use blz_core::{Config, DefaultsConfig, PathsConfig, FollowLinks};
use std::path::PathBuf;

let mut config = Config::load()?;
config.defaults.refresh_hours = 12; // Update refresh interval
config.save()?; // Persist changes

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() -> Self

Returns the “default value” for a type.

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

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.