ice::ParamDefinition Struct Reference

Basic information for each command line parameter. More...

#include <ice/params.hxx>

Public Attributes
ice::String	name
	Name(s) for the parameter to be accessible through.
ice::String	description = {}
	The description shown in the '–help' output.
ice::String	group = {}
	A group this parameter will be shown part in the '–help' output.
ice::String	type_name = {}
	Special name for the parameter accepted type hint. Defaults to parameter native type, ex.: 'ice::i32' -> 'INT'.
ice::i32	min = 0
	Minimum number of arguments required to be considered valid usage.
ice::i32	max = ice::i32_max
	Maximum number of arguments required to be considered valid usage.
ice::arr2i	typesize = { 0, ice::i32_max }
	The number of arguments expected fot this type size.
ice::ParamFlags	flags = ice::ParamFlags::None
	Flags additionally altering parsing behavior of the parameter.

Detailed Description

Basic information for each command line parameter.

Member Data Documentation

description

ice::String ice::ParamDefinition::description = {}

The description shown in the '–help' output.

flags

ice::ParamFlags ice::ParamDefinition::flags = ice::ParamFlags::None

Flags additionally altering parsing behavior of the parameter.

group

ice::String ice::ParamDefinition::group = {}

A group this parameter will be shown part in the '–help' output.

max

ice::i32 ice::ParamDefinition::max = ice::i32_max

Maximum number of arguments required to be considered valid usage.

Note

Only usable by Array and Custom parameter definitions.

min

ice::i32 ice::ParamDefinition::min = 0

Minimum number of arguments required to be considered valid usage.

Note

Only usable by Array and Custom parameter definitions.

name

ice::String ice::ParamDefinition::name

Name(s) for the parameter to be accessible through.

Allowed names are single dashes, double dashes and positional names, ex.: "-s,--multiple,positional"

Note

Names need to be unique across all defined parameters.

type_name

ice::String ice::ParamDefinition::type_name = {}

Special name for the parameter accepted type hint. Defaults to parameter native type, ex.: 'ice::i32' -> 'INT'.

typesize

ice::arr2i ice::ParamDefinition::typesize = { 0, ice::i32_max }

The number of arguments expected fot this type size.

Note

Only usable by Array and Custom parameter definitions.

---

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

• utils/public/ice/params.hxx