Struct grin_config::types::GlobalConfig

pub struct GlobalConfig {
    pub config_file_path: Option<PathBuf>,
    pub members: Option<ConfigMembers>,
}

Going to hold all of the various configuration types separately for now, then put them together as a single ServerConfig object afterwards. This is to flatten out the configuration file into logical sections, as they tend to be quite nested in the code Most structs optional, as they may or may not be needed depending on what's being run

Fields

config_file_path: Option<PathBuf>

Keep track of the file we've read

members: Option<ConfigMembers>

Global member config

Methods

impl GlobalConfig

pub fn for_chain(chain_type: &ChainTypes) -> GlobalConfig

Same as GlobalConfig::default() but further tweaks parameters to apply defaults for each chain type

pub fn new(file_path: &str) -> Result<GlobalConfig, ConfigError>

Requires the path to a config file

pub fn update_paths(&mut self, grin_home: &PathBuf)

Update paths

pub fn stratum_enabled(&mut self) -> bool

Enable mining

pub fn ser_config(&mut self) -> Result<String, ConfigError>

Serialize config

pub fn write_to_file(&mut self, name: &str) -> Result<(), ConfigError>

Write configuration to a file

Trait Implementations

impl PartialEq<GlobalConfig> for GlobalConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for GlobalConfig

fn default() -> GlobalConfig

Returns the "default value" for a type.

impl Clone for GlobalConfig

fn clone(&self) -> GlobalConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalConfig

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

Formats the value using the given formatter.

impl Serialize for GlobalConfig

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for GlobalConfig

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

Deserialize this value from the given Serde deserializer.