arg Struct Reference

Annotation for arguments. More...

#include </builds/ipbus/ipbus-software/uhal/python/pybind11-python2/include/pybind11/cast.h>

Inheritance diagram for arg:

Public Member Functions
constexpr	arg (const char *name=nullptr)
	Constructs an argument with the name of the argument; if null or omitted, this is a positional argument. More...
template<typename T >
arg_v	operator= (T &&value) const
	Assign a value to this argument. More...
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...
constexpr	arg (const char *name=nullptr)
	Constructs an argument with the name of the argument; if null or omitted, this is a positional argument. More...
template<typename T >
arg_v	operator= (T &&value) const
	Assign a value to this argument. More...
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...

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

Detailed Description

Annotation for arguments.

Definition at line 1238 of file cast.h.

Constructor & Destructor Documentation

arg() [1/2]

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 1241 of file cast.h.

arg() [2/2]

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 1243 of file cast.h.

Member Function Documentation

noconvert() [1/2]

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

inline

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

Definition at line 1247 of file cast.h.

References flag_noconvert.

Referenced by arg_v::noconvert(), and TEST_SUBMODULE().

noconvert() [2/2]

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

inline

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

Definition at line 1249 of file cast.h.

References flag_noconvert.

none() [1/2]

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 1252 of file cast.h.

References flag_none.

Referenced by arg_v::none().

none() [2/2]

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 1254 of file cast.h.

References flag_none.

operator=() [1/2]

template<typename T >

arg_v arg::operator=

(

T &&

value

)

const

Assign a value to this argument.

Definition at line 1329 of file cast.h.

References operator=().

Referenced by operator=().

operator=() [2/2]

template<typename T >

arg_v arg::operator=

(

T &&

value

)

const

Assign a value to this argument.

Member Data Documentation

flag_noconvert

bool arg::flag_noconvert

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

Definition at line 1258 of file cast.h.

Referenced by process_attribute< arg >::init(), process_attribute< arg_v >::init(), and noconvert().

flag_none

bool arg::flag_none

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

Definition at line 1260 of file cast.h.

Referenced by process_attribute< arg >::init(), process_attribute< arg_v >::init(), and none().

name

const char * arg::name

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

Definition at line 1257 of file cast.h.

Referenced by check_kw_only_arg(), cpp_function::destruct(), process_attribute< arg >::init(), process_attribute< arg_v >::init(), and unpacking_collector< policy >::process().

---

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

• python/pybind11-python2/include/pybind11/cast.h
• python/pybind11/include/pybind11/cast.h