settings#

Fully qualified name: carb::settings

namespace settings#: Namespace for carb::settings::ISettings interface and utilities.

Classes#

ScopedRead: A helper class for performing a scoped read lock on the settings database.
ScopedSubscription: Helper class to add a setting node or tree change subscription that will be automatically unregistered when the object goes out of scope.
ScopedWrite: A helper class for performing a scoped write lock on the settings database.
ThreadSafeLocalCache: A utility for caching a setting and automatically subscribing to changes of the value, as opposed to constantly polling.

Functions#

void appendToStringArray(const char *path, const std::vector< std::string > &values): Appends a set of string values to the end of a setting key.
T getSettingOrDefault(const char *path, T defaultValue={}): Access a setting key if present, otherwise returning a default value.
std::string getString(const ISettings *settings, const char *path, const std::string &defaultValue=""): Retrieves a std::string from a string-type setting for simplicity.
std::vector< std::string > getStringArray(ISettings *settings, const char *path, const std::string &defaultValue=""): A helper function for reading a setting value that is an array of string values as std::vector<std::string> .
std::vector< std::string > getStringArrayFromItemValues(ISettings *settings, const char *path, const std::string &defaultValue=""): A helper function for reading a setting value that is an array of mixed values as std::vector<std::string> .
std::string getStringAt(const ISettings *settings, const char *path, size_t index, const std::string &defaultValue=""): Retrieves a std::string from an array of string-type setting for simplicity.
cpp::optional< std::string > getStringAtOpt(const ISettings *settings, const char *path, size_t index): Retrieves a std::string from an array of string-type setting for simplicity.
std::string getStringFromItemValue(const ISettings *settings, const char *path, const std::string &defaultValue=""): Retrieves a std::string from a setting key for simplicity.
std::string getStringFromItemValueAt(const ISettings *settings, const char *path, size_t index, const std::string &defaultValue=""): Retrieves a std::string from an array setting key for simplicity.
cpp::optional< std::string > getStringOpt(const ISettings *settings, const char *path): Retrieves a std::string from a string-type setting for simplicity.
void loadSettingsFromFile(ISettings *settings, const char *path, dictionary::IDictionary *dictionary, dictionary::ISerializer *serializer, const char *filename): A helper function to load settings from a file.
void saveFileFromSettings(const ISettings *settings, dictionary::ISerializer *serializer, const char *path, const char *filename, dictionary::SerializerOptions serializerOptions): A helper function to save settings to a file.
void setBoolArray(ISettings *settings, const char *path, const std::vector< bool > &array): A helper function for setting a std::vector<bool> as an array of bools.
T setDefaultAndGetSetting(const char *path, T defaultValue={}): Sets a default value for a setting key and returns the current value.
void setFloatArray(ISettings *settings, const char *path, const std::vector< float > &array): A helper function for setting a std::vector<float> as an array of floats.
void setFloatArray(ISettings *settings, const char *path, const std::vector< double > &array): A helper function for setting a std::vector<double> as an array of doubles.
void setIntArray(ISettings *settings, const char *path, const std::vector< int64_t > &array): A helper function for setting a std::vector<int64_t> as an array of 64-bit integers.
void setIntArray(ISettings *settings, const char *path, const std::vector< int > &array): A helper function for setting a std::vector<int> as an array of integers.
void setStringArray(ISettings *settings, const char *path, const std::vector< std::string > &array): A helper function for setting a std::vector<bool> as an array of strings.
void walkSettings(carb::dictionary::IDictionary *idict, carb::settings::ISettings *settings, dictionary::WalkerMode walkerMode, const char *rootPath, ElementData rootElementData, OnItemFnType onItemFn, void *userData): A function for walking all of the settings from a given root.

Structs#

ISettings: The Carbonite Settings interface.
Transaction: An opaque type representing a settings transaction.