arg_v Struct Reference

#include <cast.h>

Inheritance diagram for arg_v:

Public Member Functions
template<typename T >
	arg_v (const char *name, T &&x, const char *descr=nullptr)
	Direct construction with name, default, and description. More...
template<typename T >
	arg_v (const arg &base, T &&x, const char *descr=nullptr)
	Called internally when invoking py::arg("a") = value More...
arg_v &	noconvert (bool flag=true)
	Same as arg::noconvert(), but returns *this as arg_v&, not arg&. More...
arg_v &	none (bool flag=true)
	Same as arg::nonone(), but returns *this as arg_v&, not arg&. More...
Public Member Functions inherited from arg
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...
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
const char *	descr
	The (optional) description of the default value. More...
std::string	type
	The C++ type name of the default value (only available when compiled in debug mode) More...
object	value
	The default value. More...
Public Attributes inherited from arg
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...
const char *	name
	If non-null, this is a named kwargs argument. More...

Private Member Functions
template<typename T >
	arg_v (arg &&base, T &&x, const char *descr=nullptr)

Detailed Description

Annotation for arguments with values

Definition at line 1870 of file cast.h.

Constructor & Destructor Documentation

template<typename T >

arg_v::arg_v ( arg &&  base, T &&  x, const char *  descr = nullptr  )

inlineprivate

Definition at line 1873 of file cast.h.

template<typename T >

arg_v::arg_v ( const char *  name, T &&  x, const char *  descr = nullptr  )

inline

Direct construction with name, default, and description.

Definition at line 1887 of file cast.h.

template<typename T >

arg_v::arg_v ( const arg &  base, T &&  x, const char *  descr = nullptr  )

inline

Called internally when invoking py::arg("a") = value

Definition at line 1892 of file cast.h.

Member Function Documentation

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

inline

Same as arg::noconvert(), but returns *this as arg_v&, not arg&.

Definition at line 1896 of file cast.h.

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

inline

Same as arg::nonone(), but returns *this as arg_v&, not arg&.

Definition at line 1899 of file cast.h.

Member Data Documentation

const char* arg_v::descr

The (optional) description of the default value.

Definition at line 1904 of file cast.h.

std::string arg_v::type

The C++ type name of the default value (only available when compiled in debug mode)

Definition at line 1907 of file cast.h.

object arg_v::value

The default value.

Definition at line 1902 of file cast.h.

---

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

• cast.h