settings.h File Reference

#include <util/fs.h>
#include <cstddef>
#include <map>
#include <string>
#include <vector>

Include dependency graph for settings.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	common::Settings
	Stored settings. More...
struct	common::SettingsSpan
	Accessor for list of settings that skips negated values when iterated over. More...

Namespaces
namespace	common

Typedefs
using	common::SettingsValue = UniValue
	Settings value type (string/integer/boolean/null variant).

Functions
bool	common::ReadSettings (const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
	Read settings file.
bool	common::WriteSettings (const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
	Write settings file.
SettingsValue	common::GetSetting (const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config, bool ignore_nonpersistent, bool get_chain_type)
	Get settings value from combined sources: forced settings, command line arguments, runtime read-write settings, and the read-only config file.
std::vector< SettingsValue >	common::GetSettingsList (const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config)
	Get combined setting value similar to GetSetting(), except if setting was specified multiple times, return a list of all the values specified.
bool	common::OnlyHasDefaultSectionSetting (const Settings &settings, const std::string &section, const std::string &name)
	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.
template<typename Map , typename Key >
auto	common::FindKey (Map &&map, Key &&key) -> decltype(&map.at(key))
	Map lookup helper.