CLI Namespace Reference

Namespaces
	detail

Classes
class	ArgumentMismatch
	Thrown when the wrong number of arguments has been received. More...
class	BadNameString
	Thrown on construction of a bad name. More...
class	CallForHelp
	-h or –help on command line More...
class	ConstructionError
	Construction errors (not in parsing) More...
class	ConversionError
	Thrown when conversion call back fails, such as when an int fails to coerce to a string. More...
class	Error
	All errors derive from this one. More...
class	ExcludesError
	Thrown when an excludes option is present. More...
class	ExtrasError
	Thrown when too many positionals or options are found. More...
class	FileError
	Thrown when parsing an INI file and it is missing. More...
class	HorribleError
class	IncorrectConstruction
	Thrown when an option is set to conflicting values (non-vector and multi args, for example) More...
class	INIError
	Thrown when extra values are found in an INI file. More...
class	InvalidError
	Thrown when validation fails before parsing. More...
struct	is_bool
struct	is_bool< bool >
struct	is_vector
struct	is_vector< std::vector< T, A > >
class	OptionAlreadyAdded
	Thrown when an option already exists. More...
class	OptionNotFound
	Thrown when counting a non-existent option. More...
class	ParseError
	Anything that can error in Parse. More...
class	RequiredError
	Thrown when a required option is missing. More...
class	RequiresError
	Thrown when a requires option is missing. More...
class	RuntimeError
	Does not output a diagnostic in CLI11_PARSE, but allows to return from main() with a specific error code. More...
class	Success
	This is a successful completion on parsing, supposed to exit. More...
class	ValidationError
	Thrown when validation of results fails. More...

Typedefs
template<bool B, class T = void>
using	enable_if_t = typename std::enable_if< B, T >::type

Enumerations
enum	ExitCodes {   ExitCodes::Success = 0, ExitCodes::IncorrectConstruction = 100, ExitCodes::BadNameString, ExitCodes::OptionAlreadyAdded,   ExitCodes::FileError, ExitCodes::ConversionError, ExitCodes::ValidationError, ExitCodes::RequiredError,   ExitCodes::RequiresError, ExitCodes::ExcludesError, ExitCodes::ExtrasError, ExitCodes::INIError,   ExitCodes::InvalidError, ExitCodes::HorribleError, ExitCodes::OptionNotFound, ExitCodes::ArgumentMismatch,   ExitCodes::BaseClass = 127 }

Typedef Documentation

enable_if_t

template<bool B, class T = void>

using CLI::enable_if_t = typedef typename std::enable_if<B, T>::type

Enumeration Type Documentation

ExitCodes

enum CLI::ExitCodes

strong

These codes are part of every error in CLI. They can be obtained from e using e.exit_code or as a quick shortcut, int values from e.get_error_code().

Enumerator
Success
IncorrectConstruction
BadNameString
OptionAlreadyAdded
FileError
ConversionError
ValidationError
RequiredError
RequiresError
ExcludesError
ExtrasError
INIError
InvalidError
HorribleError
OptionNotFound
ArgumentMismatch
BaseClass