Struct bitcoin_argsman::ArgsManagerInner

pub struct ArgsManagerInner {
    pub settings: Settings,
    pub command: Vec<String>,
    pub network: Option<String>,
    pub network_only_args: HashSet<String>,
    pub available_args: HashMap<OptionsCategory, HashMap<String, ArgsManagerArg>>,
    pub accept_any_command: bool,
    pub config_sections: LinkedList<SectionInfo>,
    pub cached_blocks_path: Option<Box<Path>>,
    pub cached_datadir_path: Option<Box<Path>>,
    pub cached_network_datadir_path: Option<Box<Path>>,
}

Fields

settings: Settings

command: Vec<String>

network: Option<String>

network_only_args: HashSet<String>

available_args: HashMap<OptionsCategory, HashMap<String, ArgsManagerArg>>

accept_any_command: bool

config_sections: LinkedList<SectionInfo>

cached_blocks_path: Option<Box<Path>>

cached_datadir_path: Option<Box<Path>>

cached_network_datadir_path: Option<Box<Path>>

Implementations

impl ArgsManagerInner

pub fn add_command(&mut self, cmd: &str, help: &str)

| Add subcommand |

pub fn add_arg(&mut self, x: &ArgDescriptor)

| Add argument |

pub fn add_hidden_args(&mut self, names: &Vec<&'static str>)

| Add many hidden arguments |

pub fn setup_cli_args(&mut self)

impl ArgsManagerInner

pub fn setup_chain_params_base_options(&mut self)

| Set the arguments for chainparams |

impl ArgsManagerInner

pub fn clear_args(&mut self)

| Clear available arguments |

pub fn clear_path_cache(&mut self)

| Clear cached directory paths |

impl ArgsManagerInner

pub fn get_arg_flags(&self, name: &str) -> Option<u32>

pub fn get_args(&self, str_arg: &str) -> Vec<String>

pub fn get_arg(&self, str_arg: &str, str_default: &str) -> String

pub fn get_int_arg(&self, str_arg: &str, n_default: i64) -> i64

| Return integer argument or default | value | | ———– | @param strArg | | Argument to get (e.g. “-foo”) | ––––– | @param nDefault | | (e.g. 1) | | ———– | @return | | command-line argument (0 if invalid | number) or default value |

pub fn get_bool_arg(&self, str_arg: &str, default: bool) -> bool

| Return boolean argument or default | value | | ———– | @param strArg | | Argument to get (e.g. “-foo”) | ––––– | @param fDefault | | (true or false) | | ———– | @return | | command-line argument or default value |

impl ArgsManagerInner

pub fn get_blocks_dir_path(&self) -> Box<Path>

| Get blocks directory path | | ———– | @return | | Blocks path which is network specific |

impl ArgsManagerInner

pub fn get_chain_name(&mut self) -> Result<String, StdException>

| Returns the appropriate chain name | from the program arguments. | | | ———– | @return | | CBaseChainParams::MAIN by default; | raises runtime error if an invalid combination | is given. |

impl ArgsManagerInner

pub fn get_command(&self) -> Option<ArgsManagerCommand>

| Get the command and command args (returns | std::nullopt if no command provided) |

impl ArgsManagerInner

pub fn get_data_dir_base(&self) -> PathBuf

| Get data directory path | | | ———– | @return | | Absolute path on success, otherwise | an empty path when a non-directory path | would be returned @post Returned directory | path is created unless it is empty |

pub fn get_data_dir_net(&self) -> PathBuf

| Get data directory path with appended | network identifier | | ———– | @return | | Absolute path on success, otherwise | an empty path when a non-directory path | would be returned @post Returned directory | path is created unless it is empty |

pub fn get_data_dir(&self, net_specific: bool) -> PathBuf

| Get data directory path | | ———– | @param net_specific | | Append network identifier to the returned | path | | ———– | @return | | Absolute path on success, otherwise | an empty path when a non-directory path | would be returned @post Returned directory | path is created unless it is empty |

impl ArgsManagerInner

pub fn get_help_message(&self) -> String

| Get the help string |

impl ArgsManagerInner

pub fn get_settings_path( &self, filepath: Option<&mut Box<Path>>, temp: Option<bool> ) -> bool

| Get settings file path, or return false | if read-write settings were disabled | with -nosettings. |

pub fn get_setting(&self, arg: &str) -> SettingsValue

| Get setting value. | | Result will be null if setting was unset, | true if “-setting” argument was passed | false if “-nosetting” argument was | passed, and a string if a “-setting=value” | argument was passed. |

pub fn get_settings_list(&self, arg: &str) -> Vec<SettingsValue>

| Get list of setting values. |

impl ArgsManagerInner

pub fn get_unrecognized_sections(&self) -> LinkedList<SectionInfo>

| Log warnings for unrecognized section | names in the config file. |

impl ArgsManagerInner

pub fn help_requested(&self) -> bool

| @return | | true if help has been requested via a | command-line arg |

pub fn setup_help_options(&mut self)

| Add help options to the args manager |

impl ArgsManagerInner

pub fn log_args_prefix( &self, prefix: &str, section: &str, args: &HashMap<String, Vec<SettingsValue>> )

| Helper function for LogArgs(). |

pub fn log_args(&self)

| Log the config file options and the command | line arguments, useful for troubleshooting. |

impl ArgsManagerInner

pub fn parse_parameters( &mut self, argv: &Vec<String>, error: &mut String ) -> bool

impl ArgsManagerInner

pub fn is_arg_set(&self, str_arg: &str) -> bool

| Return true if the given argument has | been manually set | | ———– | @param strArg | | Argument to get (e.g. “-foo”) | | ———– | @return | | true if the argument has been set |

pub fn is_arg_negated(&self, str_arg: &str) -> bool

| Return true if the argument was originally | passed as a negated option, i.e. -nofoo. | | ———– | @param strArg | | Argument to get (e.g. “-foo”) | | ———– | @return | | true if the argument was passed negated |

impl ArgsManagerInner

pub fn read_config_stream<R: Read>( &mut self, stream: &mut BufReader<R>, filepath: &str, error: &mut String, ignore_invalid_keys: Option<bool> ) -> bool

pub fn read_config_files( &mut self, error: &mut String, ignore_invalid_keys: Option<bool> ) -> bool

impl ArgsManagerInner

pub fn select_config_network(&mut self, network: &str)

| Select the network in use |

impl ArgsManagerInner

pub fn lock_settings<F: Fn(&Settings)>(&mut self, fn_: F)

| Access settings with lock held. |

pub fn init_settings(&mut self, error: &mut String) -> Result<(), String>

| Read and update settings file with saved | settings. This needs to be called after | SelectParams() because the settings | file location is network-specific. |

pub fn read_settings_file(&mut self, errors: Option<&mut Vec<String>>) -> bool

| Read settings file. Push errors to vector, | or log them if null. |

pub fn write_settings_file( &self, errors: Option<&mut Vec<String>> ) -> Result<bool, StdException>

| Write settings file. Push errors to | vector, or log them if null. |

impl ArgsManagerInner

pub fn soft_set_arg(&mut self, str_arg: &str, str_value: &str) -> bool

| Set an argument if it doesn’t already | have a value | | ———– | @param strArg | | Argument to set (e.g. “-foo”) | ––––– | @param strValue | | Value (e.g. “1”) | | ———– | @return | | true if argument gets set, false if it | already had a value |

pub fn force_set_arg(&mut self, str_arg: &str, str_value: &str)

| Forces an arg setting. Called by | | SoftSetArg() if the arg hasn’t already | been set. Also called directly in testing. |

pub fn soft_set_bool_arg(&mut self, str_arg: &str, value: bool) -> bool

| Set a boolean argument if it doesn’t | already have a value | | ———– | @param strArg | | Argument to set (e.g. “-foo”) | ––––– | @param fValue | | Value (e.g. false) | | ———– | @return | | true if argument gets set, false if it | already had a value |

impl ArgsManagerInner

pub fn use_default_section(&self, arg: &str) -> bool

| Returns true if settings values from | the default section should be used, | depending on the current network and | whether the setting is network-specific. |

Trait Implementations

impl Default for ArgsManagerInner

fn default() -> ArgsManagerInner

Returns the “default value” for a type.