carb::settings

namespace settings

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

Classes

• carb::settings::ScopedRead: A helper class for performing a scoped read lock on the settings database.

• carb::settings::ScopedSubscription: Helper class to add a setting node or tree change subscription that will be automatically unregistered when the object goes out of scope.

• carb::settings::ScopedWrite: A helper class for performing a scoped write lock on the settings database.

• carb::settings::ThreadSafeLocalCache: A utility for caching a setting and automatically subscribing to changes of the value, as opposed to constantly polling.

Functions

• carb::settings::appendToStringArray: Appends a set of string values to the end of a setting key.

• carb::settings::getSettingOrDefault: Access a setting key if present, otherwise returning a default value.

• carb::settings::getString: Retrieves a std::string from a string-type setting for simplicity.

• carb::settings::getStringArray: A helper function for reading a setting value that is an array of string values as std::vector<std::string> .

• carb::settings::getStringArrayFromItemValues: A helper function for reading a setting value that is an array of mixed values as std::vector<std::string> .

• carb::settings::getStringAt: Retrieves a std::string from an array of string-type setting for simplicity.

• carb::settings::getStringFromItemValue: Retrieves a std::string from a setting key for simplicity.

• carb::settings::getStringFromItemValueAt: Retrieves a std::string from an array setting key for simplicity.

• carb::settings::loadSettingsFromFile: A helper function to load settings from a file.

• carb::settings::saveFileFromSettings: A helper function to save settings to a file.

• carb::settings::setBoolArray: A helper function for setting a std::vector<bool> as an array of bools.

• carb::settings::setDefaultAndGetSetting: Sets a default value for a setting key and returns the current value.

• carb::settings::setFloatArray: A helper function for setting a std::vector<float> as an array of floats.

• carb::settings::setFloatArray: A helper function for setting a std::vector<double> as an array of doubles.

• carb::settings::setIntArray: A helper function for setting a std::vector<int64_t> as an array of 64-bit integers.

• carb::settings::setIntArray: A helper function for setting a std::vector<int> as an array of integers.

• carb::settings::setStringArray: A helper function for setting a std::vector<bool> as an array of strings.

• carb::settings::walkSettings: A function for walking all of the settings from a given root.

Structs

• carb::settings::ISettings: The Carbonite Settings interface.

• carb::settings::Transaction: An opaque type representing a settings transaction.