OXY-SYNC-DIRECTORY 1.0
OXY-SYNC-DIRECTORY Library Documentation
Loading...
Searching...
No Matches
settings.hpp File Reference

Configuration settings for the oxy directory service, including folder paths, file filters, network settings, and SSL certificate paths. More...

Classes

struct  oxy::directory::settings::config_path_t
 A singleton struct that holds the file path to the configuration INI file. More...
struct  oxy::directory::settings::expand_fn
 A function object that expands environment variables in the settings paths. More...
struct  oxy::directory::settings::get_fn
 A function object that retrieves configuration settings. More...
struct  oxy::directory::settings::load_fn
 A function object that loads configuration settings from an INI file. More...
struct  oxy::directory::settings::remove_quote_fn
 A function object that removes surrounding quotes from a string if they exist. More...
struct  oxy::directory::settings::set_fn
 A function object that sets configuration properties in an INI file. More...
struct  oxy::directory::settings::settings_t
 Represents the configuration settings for the oxy directory service. More...

Namespaces

namespace  oxy::directory
 The oxy::directory namespace contains interfaces and functions for synchronizing and updating the metadata directory.

Typedefs

using oxy::directory::settings::properties = std::map<std::string, std::variant<std::string, int, double>>
 A type alias for a map of configuration properties, where each property is represented as a variant of string, int, or double.

Variables

constexpr expand_fn oxy::directory::settings::expand
 A constexpr instance of the expand_fn function object for use in functional programming.
constexpr const char oxy::directory::settings::FILE_PATH [] = R"(%ProgramData%\BildoSoft\oxy\oxy.ini)"
 The default file path for the configuration INI file.
const constexpr auto oxy::directory::settings::get = get_fn{}
 A constexpr instance of the get_fn function object for use in functional programming.
const constexpr auto oxy::directory::settings::load = load_fn{}
 A constexpr instance of the load_fn function object for use in functional programming.
constexpr remove_quote_fn oxy::directory::settings::remove_quote
 A constexpr instance of the remove_quote_fn function object for use in functional programming.
const constexpr auto oxy::directory::settings::set = set_fn{}
 A constexpr instance of the set_fn function object for use in functional programming.

Detailed Description

Configuration settings for the oxy directory service, including folder paths, file filters, network settings, and SSL certificate paths.

This header defines the settings_t struct, which holds various configuration parameters used by the oxy directory service. It includes paths for logs, directories, packs, and plugins, as well as SSL certificate paths and network settings such as host and port. The header also provides function objects for removing quotes from strings, expanding environment variables in settings paths, and loading settings from an INI configuration file.

Note
The remove_quote_fn, expand_fn, and load_fn function objects are designed to be used in functional programming contexts, allowing for easy manipulation and retrieval of configuration settings. The FILE_PATH constant defines the default path for the configuration INI file, and the config_path_t struct provides a singleton instance for accessing the configuration file path.