Struct Config 

pub struct Config {
    pub chains: ChainsConfig,
    pub output: OutputConfig,
    pub address_book: AddressBookConfig,
    pub monitor: MonitorConfig,
}

Application configuration.

Contains all settings for blockchain clients, output formatting, and address book management. Use Config::load to load from file or Config::default for sensible defaults.

Examples

use scope::Config;

// Load from default location or custom path
let config = Config::load(None).unwrap_or_default();
println!("Output format: {:?}", config.output.format);

Fields

chains: ChainsConfig

Blockchain chain client configuration.

output: OutputConfig

Output formatting configuration.

address_book: AddressBookConfig

Address book configuration (label → address mapping storage).

monitor: MonitorConfig

Monitor TUI configuration (layout, widgets, refresh rate).

Implementations

impl Config

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

Loads configuration from a file path or the default location.

Arguments

• path - Optional path to a configuration file. If None, looks for config at ~/.config/scope/config.yaml.

Returns

Returns the loaded configuration, or defaults if no config file exists.

Errors

Returns ScopeError::Config if the file exists but cannot be read or contains invalid YAML.

Examples

use scope::Config;
use std::path::Path;

// Load from default location
let config = Config::load(None).unwrap_or_default();

// Load from custom path
let config = Config::load(Some(Path::new("/custom/config.yaml")));

pub fn default_path() -> PathBuf

Returns the default configuration file path.

Checks multiple locations in order:

1. ~/.config/scope/config.yaml (XDG-style, preferred for CLI tools)
2. Platform-specific config dir (e.g., ~/Library/Application Support/ on macOS)

Returns the first location that exists, or the XDG-style path if neither exists.

pub fn config_path() -> Option<PathBuf>

Returns the configuration file path, if it can be determined.

Returns Some(path) for the config file location, or None if the path cannot be determined (e.g., no home directory). Prefers the XDG-style ~/.config/scope/ location.

pub fn default_data_dir() -> PathBuf

Returns the default data directory for address book storage.

On Linux/macOS: ~/.local/share/scope On Windows: %LOCALAPPDATA%\scope

pub fn data_dir(&self) -> PathBuf

Returns the effective data directory, using config or default.

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 PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for Config