arg Struct Reference

#include <cast.h>

Inheritance diagram for arg:

Public Member Functions
constexpr	arg (const char *name=nullptr)
arg &	noconvert (bool flag=true)
	Indicate that the type should not be converted in the type caster. More...
arg &	none (bool flag=true)
	Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args) More...
template<typename T >
arg_v	operator= (T &&value) const
	Assign a value to this argument. More...

Public Attributes
bool	flag_noconvert: 1
bool	flag_none: 1
	If set (the default), allow None to be passed to this argument. More...
const char *	name
	If non-null, this is a named kwargs argument. More...

Detailed Description

Annotation for arguments

Definition at line 1419 of file cast.h.

Constructor & Destructor Documentation

arg()

constexpr arg::arg ( const char *  name = nullptr )

inlineexplicitconstexpr

Constructs an argument with the name of the argument; if null or omitted, this is a positional argument.

Definition at line 1422 of file cast.h.

Member Function Documentation

noconvert()

arg& arg::noconvert ( bool  flag = true )

inline

Indicate that the type should not be converted in the type caster.

Definition at line 1428 of file cast.h.

none()

arg& arg::none ( bool  flag = true )

inline

Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args)

Definition at line 1433 of file cast.h.

operator=()

template<typename T >

arg_v arg::operator=

(

T &&

value

)

const

Assign a value to this argument.

Definition at line 1510 of file cast.h.

Member Data Documentation

flag_noconvert

bool arg::flag_noconvert

If set, do not allow conversion (requires a supporting type caster!)

Definition at line 1439 of file cast.h.

flag_none

bool arg::flag_none

If set (the default), allow None to be passed to this argument.

Definition at line 1441 of file cast.h.

name

const char* arg::name

If non-null, this is a named kwargs argument.

Definition at line 1438 of file cast.h.

---

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

• cast.h