Crate bitcoin_settings

source ·

Structs

  • Settings
    | Stored settings. This struct combines settings | from the command line, a read-only | configuration file, and a read-write runtime | settings file.
  • SettingsSpan
    | Accessor for list of settings that skips | negated values when iterated over. | | The last boolean false value in the list and | all earlier values are considered negated.
  • SettingsTuple
  • SettingsValue
    | Settings value type | (string/integer/boolean/null variant). | | @note UniValue is used here for convenience | and because it can be easily serialized | in a readable format. But any other | variant type that can be assigned | strings, int64_t, and bool values and | has get_str(), get_int64(), get_bool(), | isNum(), isBool(), isFalse(), isTrue() | and | isNull() methods can be substituted if | there’s a need to move away from | UniValue. (An implementation with | boost::variant was posted at | https://github.com/bitcoin/bitcoin/pull/15934/files#r337691812)

Enums

Functions

  • get_setting
    | Get settings value from combined sources: | forced settings, command line arguments, | runtime read-write settings, and the | read-only config file. | | ———– | @param ignore_default_section_config | | - ignore values in the default section | of the config file (part before any [section] | keywords) | ––––– | @param get_chain_name | | - enable special backwards compatible | behavior for GetChainName |
  • get_settings_list
    | Get combined setting value similar to | GetSetting(), except if setting was specified | multiple times, return a list of all the | values specified.
  • merge_settings
    | Merge settings from multiple sources in | precedence order: | | Forced config > command line > read-write | settings file > config file network-specific | section > config file default section | | This function is provided with a callback | function fn that contains specific logic for | how to merge the sources.
  • only_has_default_section_setting
    | Return true if a setting is set in the default | config file section, and not overridden by | a higher priority command-line or network | section value. | | This is used to provide user warnings about | values that might be getting ignored | unintentionally.
  • read_settings
    | Read settings file. |
  • write_settings
    | Write settings file. |