ChainCLI
A modern C++20 command-line interface library
Loading...
Searching...
No Matches
cli::parsing::GroupParseException Class Reference

Exception thrown when parsing a group of arguments fails. More...

#include <parse_exception.h>

Inheritance diagram for cli::parsing::GroupParseException:

Public Member Functions

 GroupParseException (const std::string &message, const cli::commands::ArgumentGroup &argumentGroup)
 Construct a GroupParseException with a message and argument group.
 
 GroupParseException (const cli::commands::ArgumentGroup &argumentGroup)
 Construct a GroupParseException with default message and argument group.
 
const cli::commands::ArgumentGroupgetArgumentGroup () const noexcept
 Gets the argument group that failed to parse.
 

Detailed Description

Exception thrown when parsing a group of arguments fails.

Constructor & Destructor Documentation

◆ GroupParseException() [1/2]

cli::parsing::GroupParseException::GroupParseException ( const std::string &  message,
const cli::commands::ArgumentGroup argumentGroup 
)
inline

Construct a GroupParseException with a message and argument group.

Parameters
messageThe error message
argumentGroupThe argument group that failed to parse

◆ GroupParseException() [2/2]

cli::parsing::GroupParseException::GroupParseException ( const cli::commands::ArgumentGroup argumentGroup)
inlineexplicit

Construct a GroupParseException with default message and argument group.

Parameters
argumentGroupThe argument group that failed to parse

Member Function Documentation

◆ getArgumentGroup()

const cli::commands::ArgumentGroup & cli::parsing::GroupParseException::getArgumentGroup ( ) const
inlinenoexcept

Gets the argument group that failed to parse.

Returns
reference to the argument group

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