clipp::parsing_result Class Reference

contains argument -> parameter mappings and missing parameters More...

#include <clipp.h>

Public Types
using	arg_mapping = parser::arg_mapping
using	arg_mappings = parser::arg_mappings
using	missing_event = parser::missing_event
using	missing_events = parser::missing_events
using	iterator = arg_mappings::const_iterator

Public Member Functions
	parsing_result ()=default
	default: empty redult More...
	parsing_result (arg_mappings arg2param, missing_events misses)
arg_mappings::size_type	unmapped_args_count () const noexcept
	returns number of arguments that could not be mapped to a parameter More...
bool	any_blocked () const noexcept
	returns if any argument could only be matched by an unreachable parameter More...
bool	any_conflict () const noexcept
	returns if any argument matched more than one parameter that were mutually exclusive More...
bool	any_bad_repeat () const noexcept
	returns if any parameter matched repeatedly although it was not allowed to More...
bool	any_error () const noexcept
	returns true if any parsing error / violation of the command line interface definition occured More...
	operator bool () const noexcept
	returns true if no parsing error / violation of the command line interface definition occured More...
const missing_events &	missing () const noexcept
	access to range of missing parameter match events More...
iterator	begin () const noexcept
	returns non-mutating iterator to position of first argument -> parameter mapping More...
iterator	end () const noexcept
	returns non-mutating iterator to position one past the last argument -> parameter mapping More...

Detailed Description

contains argument -> parameter mappings and missing parameters

Definition at line 4743 of file clipp.h.

Member Typedef Documentation

arg_mapping

using clipp::parsing_result::arg_mapping = parser::arg_mapping

Definition at line 4746 of file clipp.h.

arg_mappings

using clipp::parsing_result::arg_mappings = parser::arg_mappings

Definition at line 4747 of file clipp.h.

iterator

using clipp::parsing_result::iterator = arg_mappings::const_iterator

Definition at line 4750 of file clipp.h.

missing_event

using clipp::parsing_result::missing_event = parser::missing_event

Definition at line 4748 of file clipp.h.

missing_events

using clipp::parsing_result::missing_events = parser::missing_events

Definition at line 4749 of file clipp.h.

Constructor & Destructor Documentation

parsing_result() [1/2]

clipp::parsing_result::parsing_result ( )

default

default: empty redult

parsing_result() [2/2]

clipp::parsing_result::parsing_result ( arg_mappings  arg2param, missing_events  misses  )

inline

Definition at line 4756 of file clipp.h.

Member Function Documentation

any_bad_repeat()

bool clipp::parsing_result::any_bad_repeat ( ) const

inlinenoexcept

returns if any parameter matched repeatedly although it was not allowed to

Definition at line 4787 of file clipp.h.

any_blocked()

bool clipp::parsing_result::any_blocked ( ) const

inlinenoexcept

returns if any argument could only be matched by an unreachable parameter

Definition at line 4773 of file clipp.h.

any_conflict()

bool clipp::parsing_result::any_conflict ( ) const

inlinenoexcept

returns if any argument matched more than one parameter that were mutually exclusive

Definition at line 4780 of file clipp.h.

any_error()

bool clipp::parsing_result::any_error ( ) const

inlinenoexcept

returns true if any parsing error / violation of the command line interface definition occured

Definition at line 4794 of file clipp.h.

begin()

iterator clipp::parsing_result::begin ( ) const

inlinenoexcept

returns non-mutating iterator to position of first argument -> parameter mapping

Definition at line 4808 of file clipp.h.

end()

iterator clipp::parsing_result::end ( ) const

inlinenoexcept

returns non-mutating iterator to position one past the last argument -> parameter mapping

Definition at line 4811 of file clipp.h.

missing()

const missing_events& clipp::parsing_result::missing ( ) const

inlinenoexcept

access to range of missing parameter match events

Definition at line 4804 of file clipp.h.

operator bool()

clipp::parsing_result::operator bool ( ) const

inlineexplicitnoexcept

returns true if no parsing error / violation of the command line interface definition occured

Definition at line 4801 of file clipp.h.

unmapped_args_count()

arg_mappings::size_type clipp::parsing_result::unmapped_args_count ( ) const

inlinenoexcept

returns number of arguments that could not be mapped to a parameter

Definition at line 4765 of file clipp.h.

---

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

• clipp.h