Loading...
Searching...
No Matches
Config Class Referenceabstract

This class provides a converter for configuration files. More...

#include <CLI11.h>

+ Inheritance diagram for Config:

Public Member Functions

virtual std::string to_config (const App *, bool, bool, std::string) const =0
 Convert an app into a configuration.
 
virtual std::vector< ConfigItemfrom_config (std::istream &) const =0
 Convert a configuration into an app.
 
virtual CLI11_NODISCARD std::string to_flag (const ConfigItem &item) const
 Get a flag value.
 
CLI11_NODISCARD std::vector< ConfigItemfrom_file (const std::string &name) const
 Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure.
 
virtual ~Config ()=default
 Virtual destructor.
 

Protected Attributes

std::vector< ConfigItemitems {}
 

Detailed Description

This class provides a converter for configuration files.

Definition at line 2676 of file CLI11.h.

Constructor & Destructor Documentation

◆ ~Config()

virtual ~Config ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ from_config()

virtual std::vector< ConfigItem > from_config ( std::istream &  ) const
pure virtual

Convert a configuration into an app.

Implemented in ConfigBase.

◆ from_file()

CLI11_NODISCARD std::vector< ConfigItem > from_file ( const std::string &  name) const
inline

Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure.

Definition at line 2699 of file CLI11.h.

◆ to_config()

virtual std::string to_config ( const App ,
bool  ,
bool  ,
std::string   
) const
pure virtual

Convert an app into a configuration.

Implemented in ConfigBase.

◆ to_flag()

virtual CLI11_NODISCARD std::string to_flag ( const ConfigItem item) const
inlinevirtual

Get a flag value.

Definition at line 2688 of file CLI11.h.

Member Data Documentation

◆ items

std::vector<ConfigItem> items {}
protected

Definition at line 2678 of file CLI11.h.


The documentation for this class was generated from the following file: