Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub chains: ChainsConfig,
    pub output: OutputConfig,
    pub address_book: AddressBookConfig,
    pub monitor: MonitorConfig,
    pub ghola: GholaConfig,
    pub web: WebConfig,
    pub market: MarketConfig,
}
Expand description

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).

§ghola: GholaConfig

Ghola sidecar configuration for stealth HTTP transport.

§web: WebConfig

Web server configuration.

§market: MarketConfig

Market analysis configuration (order book health thresholds).

Implementations§

Source§

impl Config

Source

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 ~/.scope-bca/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")));
Source

pub fn default_path() -> PathBuf

Returns the default configuration file path: <home>/config.yaml (see crate::paths).

Source

pub fn config_path() -> Option<PathBuf>

Returns the configuration file path that setup and scope web write: <home>/config.yaml.

Source

pub fn default_data_dir() -> PathBuf

Returns the default data directory for address book storage: <home>/data.

Source

pub fn data_dir(&self) -> PathBuf

Returns the effective data directory, using config or default. A leading ~ in the config is the user’s home folder.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config
where Config: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more