Struct ToolConfig 

pub struct ToolConfig {
    pub meta: ToolMeta,
    pub fetch: FetchConfig,
    pub index: IndexConfig,
}

Per-source configuration that overrides global defaults.

Each documentation source can have its own configuration file (settings.toml) that overrides the global configuration for that specific source. This allows fine-grained control over fetching behavior, indexing parameters, and metadata.

File Location

Stored as <cache_root>/<source_alias>/settings.toml

Example Configuration File

[meta]
name = "react"
display_name = "React Documentation"
homepage = "https://react.dev"
repo = "https://github.com/facebook/react"

[fetch]
refresh_hours = 12  # Override global default
follow_links = "first_party"
allowlist = ["reactjs.org", "react.dev"]

[index]
max_heading_block_lines = 500

Fields

meta: ToolMeta

Metadata about the documentation source

fetch: FetchConfig

Fetching behavior overrides

index: IndexConfig

Indexing parameter overrides

Implementations

impl ToolConfig

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

Load per-source configuration from a file.

Loads and parses a TOML configuration file for a specific documentation source. The file should contain sections for [meta], [fetch], and [index].

Arguments

• path - Path to the configuration file (typically settings.toml)

Returns

Returns the parsed configuration.

Errors

Returns an error if:

• The file cannot be read (doesn’t exist, permissions, I/O error)
• The file contains invalid TOML syntax
• The file contains invalid configuration values
• Required fields are missing (e.g., meta.name)

Examples

use blz_core::ToolConfig;
use std::path::Path;

// Load source-specific configuration
let config_path = Path::new("sources/react/settings.toml");
let tool_config = ToolConfig::load(config_path)?;

println!("Source: {}", tool_config.meta.name);
if let Some(refresh) = tool_config.fetch.refresh_hours {
    println!("Custom refresh interval: {} hours", refresh);
}

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

Save per-source configuration to a file.

Serializes the configuration to TOML format and writes it to the specified path. The parent directory must already exist.

Arguments

• path - Path where to save the configuration file

Errors

Returns an error if:

• The configuration cannot be serialized to TOML
• The parent directory doesn’t exist
• The file cannot be written (permissions, disk space, I/O error)

Examples

use blz_core::{ToolConfig, ToolMeta, FetchConfig, IndexConfig};
use std::path::Path;

let config = ToolConfig {
    meta: ToolMeta {
        name: "my-docs".to_string(),
        display_name: Some("My Documentation".to_string()),
        homepage: None,
        repo: None,
    },
    fetch: FetchConfig {
        refresh_hours: Some(6),
        follow_links: None,
        allowlist: None,
    },
    index: IndexConfig {
        max_heading_block_lines: Some(300),
        filter_non_english: None,
    },
};

let config_path = Path::new("my-docs/settings.toml");
config.save(config_path)?;

Trait Implementations

impl Clone for ToolConfig

fn clone(&self) -> ToolConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.