OXY API 1.0
OXY API Library Documentation
Loading...
Searching...
No Matches
settings.hpp File Reference

Configuration settings for the oxy core library. More...

Classes

struct  oxy::core::config_path_t
 Singleton structure to hold the default configuration file path. More...
struct  oxy::core::expand_fn
 Function object to expand environment variables in settings paths. More...
struct  oxy::core::get_fn
 Function object to retrieve settings, either from the default configuration file or a specified file. More...
struct  oxy::core::load_fn
 Function object to load settings from an INI file. More...
struct  oxy::core::remove_quote_fn
 Function object to remove quotes from a string. More...
struct  oxy::core::set_fn
 A function object that writes properties to an INI configuration file. More...
struct  oxy::core::settings_t
 Configuration settings for the oxy core library. More...
struct  oxy::core::settings_t::ports_t
 Defines port numbers for container and directory services. More...

Namespaces

namespace  oxy
 This root namespace contains the common types and operations for the OXY-API library.
namespace  oxy::core
 This namespace contains core types and operations for the OXY-API library.

Typedefs

using oxy::core::path_t = std::filesystem::path
 Type alias for a filesystem path.
using oxy::core::properties = std::map<std::string, std::variant<std::string, int, double>>
 Type alias for a map of properties, where each property can be a string, int, or double.
using oxy::core::ptree_t = boost::property_tree::ptree
 Type alias for a Boost property tree.

Variables

constexpr expand_fn oxy::core::expand
 A constexpr instance of the expand_fn function object for use in functional programming.
constexpr get_fn oxy::core::get
 A constexpr instance of the get_fn function object for use in functional programming.
constexpr load_fn oxy::core::load
 A constexpr instance of the load_fn function object for use in functional programming.
constexpr remove_quote_fn oxy::core::remove_quote
 A constexpr instance of the remove_quote_fn function object for use in functional programming.
constexpr set_fn oxy::core::set
 A constexpr instance of the set_fn function object for use in functional programming.

Detailed Description

Configuration settings for the oxy core library.

This header defines the settings_t structure, which holds configuration settings for the oxy core library. It includes paths for logs, containers, directories, packs, plugins, SSL certificates, and service ports. The settings can be loaded from an INI file and expanded to resolve environment variables. The header also provides function objects for loading and retrieving settings, as well as setting properties in the configuration file.

@license MPL-2.0