config_fwd.cpp File Reference

Declarations for configuration-file readers and writers. More...

import cli11:error;
import std;

Classes
struct	cli::config_item_t
	One entry read from a configuration file. More...
class	cli::config_t
	Interface for converting between an application and a configuration file. More...
class	cli::config_base_t
	A configuration converter for INI and TOML files. More...
class	cli::config_ini_t
	A configuration converter producing standard INI output. More...

Typedefs
using	cli::config_toml_t = config_base_t
	The default configuration format, which is TOML.

Enumerations
enum class	cli::config_output_mode_t : std::uint8_t { active = 0 , all_defaults , active_subcommand_defaults }
	How much of an application is written out to a configuration file. More...

Detailed Description

Declarations for configuration-file readers and writers.

A configuration converter turns an cli::app_t into text and back again. cli::config_t is the interface; cli::config_base_t implements it for TOML-shaped files and exposes the punctuation as settings, so cli::config_ini_t is the same reader with different characters.

The implementations live in the config partition. This one is separate so that app_t can hold a config converter without a circular dependency.

Enumeration Type Documentation

config_output_mode_t

enum class cli::config_output_mode_t : std::uint8_t

exportstrong

How much of an application is written out to a configuration file.

Enumerator
active	Only options that were actually set.
all_defaults	Every option, including untouched defaults.
active_subcommand_defaults	Defaults, but only for subcommands that were used.