mx::Argument< String > Struct Template Reference

A parsed or registered command-line argument definition. More...

#include <argz.hpp>

Public Member Functions
	Argument ()
	Argument (const Argument &a)
Argument &	operator= (const Argument< String > &a)
auto	operator<=> (const Argument< String > &a) const

Public Attributes
String	arg_name
	long option name (for double-dash)
int	arg_letter
	short option character code
String	arg_value
	parsed value (for value-taking options)
ArgType	arg_type
	switch type
String	desc
	help description

Detailed Description

template<StringType String>
struct mx::Argument< String >

A parsed or registered command-line argument definition.

Template Parameters

String

A StringType-constrained string class

Definition at line 52 of file argz.hpp.

Constructor & Destructor Documentation

Argument() [1/2]

template<StringType String>

mx::Argument< String >::Argument ( )

inline

Definition at line 58 of file argz.hpp.

References arg_letter, arg_name, arg_type, arg_value, and desc.

Referenced by Argument(), operator<=>(), and operator=().

Argument() [2/2]

template<StringType String>

mx::Argument< String >::Argument ( const Argument< String > & a )

inline

Definition at line 59 of file argz.hpp.

References Argument(), arg_letter, arg_name, arg_type, arg_value, and desc.

Member Function Documentation

operator<=>()

template<StringType String>

auto mx::Argument< String >::operator<=> ( const Argument< String > & a ) const

inline

Definition at line 68 of file argz.hpp.

References Argument(), and arg_letter.

operator=()

template<StringType String>

Argument & mx::Argument< String >::operator= ( const Argument< String > & a )

inline

Definition at line 60 of file argz.hpp.

References Argument(), arg_letter, arg_name, arg_type, arg_value, and desc.

Member Data Documentation

arg_letter

template<StringType String>

int mx::Argument< String >::arg_letter

short option character code

Definition at line 54 of file argz.hpp.

Referenced by Argument(), Argument(), mx::Argz< String >::addOptionDouble(), mx::Argz< String >::addOptionDoubleValue(), mx::Argz< String >::addOptionSingle(), mx::Argz< String >::addOptionSingleValue(), operator<=>(), and operator=().

arg_name

template<StringType String>

String mx::Argument< String >::arg_name

long option name (for double-dash)

Definition at line 53 of file argz.hpp.

Referenced by Argument(), Argument(), mx::Argz< String >::addOptionDouble(), mx::Argz< String >::addOptionDoubleValue(), operator=(), and mx::Argz< String >::proc().

arg_type

template<StringType String>

ArgType mx::Argument< String >::arg_type

switch type

Definition at line 56 of file argz.hpp.

Referenced by Argument(), Argument(), mx::Argz< String >::addOptionDouble(), mx::Argz< String >::addOptionDoubleValue(), mx::Argz< String >::addOptionSingle(), mx::Argz< String >::addOptionSingleValue(), operator=(), and mx::Argz< String >::proc().

arg_value

template<StringType String>

String mx::Argument< String >::arg_value

parsed value (for value-taking options)

Definition at line 55 of file argz.hpp.

Referenced by Argument(), Argument(), main(), operator=(), mx::Argz< String >::proc(), mx::proc_args(), and proc_args().

desc

template<StringType String>

String mx::Argument< String >::desc

help description

Definition at line 57 of file argz.hpp.

Referenced by Argument(), Argument(), mx::Argz< String >::addOptionDouble(), mx::Argz< String >::addOptionDoubleValue(), mx::Argz< String >::addOptionSingle(), mx::Argz< String >::addOptionSingleValue(), and operator=().

---

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

• src/vm/include/argz.hpp