Fancy argparser
Single file argument parser for c++
Loading...
Searching...
No Matches
ARGPARSE_NAMESPACE_NAME::NamedArgSpec Struct Reference

Aggregate description of a named argument, for keyword-style construction. More...

#include <argparse.h>

Public Attributes

std::string shortName = ""
std::string longName = ""
int nargs = 1
ArgTypeCast type = ArgTypeCast::e_String
bool required = true
std::string help = ""

Detailed Description

Aggregate description of a named argument, for keyword-style construction.

Because it is a plain aggregate, C++20 designated initializers give a Python-like call site:

parser.AddArgument(argparse::CreateNamedArgument({
.longName = "numbers",
.nargs = argparse::kFromOneToInfiniteArgCount,
.type = argparse::ArgTypeCast::e_int,
.required = false,
.help = "some numbers"}));

The same struct also works with ordinary aggregate init in C++11/14/17.

Definition at line 608 of file argparse.h.

Member Data Documentation

◆ help

std::string ARGPARSE_NAMESPACE_NAME::NamedArgSpec::help = ""

Definition at line 615 of file argparse.h.

◆ longName

std::string ARGPARSE_NAMESPACE_NAME::NamedArgSpec::longName = ""

Definition at line 611 of file argparse.h.

◆ nargs

int ARGPARSE_NAMESPACE_NAME::NamedArgSpec::nargs = 1

Definition at line 612 of file argparse.h.

◆ required

bool ARGPARSE_NAMESPACE_NAME::NamedArgSpec::required = true

Definition at line 614 of file argparse.h.

◆ shortName

std::string ARGPARSE_NAMESPACE_NAME::NamedArgSpec::shortName = ""

Definition at line 610 of file argparse.h.

◆ type

ArgTypeCast ARGPARSE_NAMESPACE_NAME::NamedArgSpec::type = ArgTypeCast::e_String

Definition at line 613 of file argparse.h.


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