cli11
Loading...
Searching...
No Matches
cli::option_not_found_t Class Referenceexport
module cli11

A lookup by name found no matching option. More...

Inheritance diagram for cli::option_not_found_t:
cli::detail::error_mixin_t< option_not_found_t, error_t > cli::error_t

Public Member Functions

 option_not_found_t (const std::string &name)
 Constructs the error for a failed lookup.
Public Member Functions inherited from cli::detail::error_mixin_t< option_not_found_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 = "option_not_found"
 Short name reported by error_t::get_name.

Additional Inherited Members

Protected Member Functions inherited from cli::detail::error_mixin_t< option_not_found_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 lookup by name found no matching option.

This derives from error_t rather than parse_error_t: it reports a bad query from the calling code, not a bad command line.

Constructor & Destructor Documentation

◆ option_not_found_t()

cli::option_not_found_t::option_not_found_t ( const std::string & name)
inlineexplicit

Constructs the error for a failed lookup.

Parameters
nameThe name that was looked up.

The documentation for this class was generated from the following file:
  • /home/mccakit/desktop/repositories/cli11/src/error.cpp