A value failed one of the option's validators. More...

Inheritance diagram for cli::validation_error_t:

Public Member Functions
	validation_error_t (std::string msg)
	Constructs the error with the default exit code.
	validation_error_t (const std::string &name, const std::string &msg)
	Constructs the error, prefixing the message with the option name.
Public Member Functions inherited from cli::detail::error_mixin_t< validation_error_t, parse_error_t >
	error_mixin_t (std::string msg, exit_codes_t exit_code)
	Constructs the error, naming it from `derived_t`.
	error_mixin_t (std::string msg, int exit_code)
	Constructs the error, naming it from `derived_t`.
Public Member Functions inherited from cli::detail::error_mixin_t< parse_error_t, error_t >
	error_mixin_t (std::string msg, exit_codes_t exit_code)
	Constructs the error, naming it from `derived_t`.
	error_mixin_t (std::string msg, int exit_code)
	Constructs the error, naming it from `derived_t`.
Public Member Functions inherited from cli::error_t
auto	get_exit_code () const -> int
	Returns the process exit code associated with this error.
auto	get_name () const -> std::string
	Returns the short name of this error type.
	error_t (std::string name, std::string msg, int exit_code=static_cast< int >(exit_codes_t::base_class))
	Constructs an error with an explicit numeric exit code.
	error_t (std::string name, std::string msg, exit_codes_t exit_code)
	Constructs an error with an exit code drawn from exit_codes_t.

Static Public Attributes
static constexpr std::string_view	error_type_name = "validation_error"
	Short name reported by error_t::get_name.
Static Public Attributes inherited from cli::parse_error_t
static constexpr std::string_view	error_type_name = "parse_error"
	Short name reported by error_t::get_name.

Additional Inherited Members
Protected Member Functions inherited from cli::detail::error_mixin_t< validation_error_t, parse_error_t >
	error_mixin_t (std::string ename, std::string msg, int exit_code)
	Forwards an explicit type name, for further derivation.
	error_mixin_t (std::string ename, std::string msg, exit_codes_t exit_code)
	Forwards an explicit type name, for further derivation.
Protected Member Functions inherited from cli::detail::error_mixin_t< parse_error_t, error_t >
	error_mixin_t (std::string ename, std::string msg, int exit_code)
	Forwards an explicit type name, for further derivation.
	error_mixin_t (std::string ename, std::string msg, exit_codes_t exit_code)
	Forwards an explicit type name, for further derivation.

Detailed Description

A value failed one of the option's validators.

Constructor & Destructor Documentation

cli::validation_error_t::validation_error_t ( std::string msg )

inlineexplicit

Constructs the error with the default exit code.

Parameters

msg	Human-readable description.

cli::validation_error_t::validation_error_t	(	const std::string &	name,
		const std::string &	msg )

inline

Constructs the error, prefixing the message with the option name.

Parameters

name	The option that failed validation.
msg	Human-readable description.

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