pybind11::arg_v Struct Reference

#include <cast.h>

Inheritance diagram for pybind11::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.
template<typename T >
	arg_v (const arg &base, T &&x, const char *descr=nullptr)
	Called internally when invoking py::arg("a") = value
arg_v &	noconvert (bool flag=true)
	Same as arg::noconvert(), but returns *this as arg_v&, not arg&.
arg_v &	none (bool flag=true)
	Same as arg::nonone(), but returns *this as arg_v&, not arg&.
Public Member Functions inherited from pybind11::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.
template<typename T >
arg_v	operator= (T &&value) const
	Assign a value to this argument.
arg &	noconvert (bool flag=true)
	Indicate that the type should not be converted in the type caster.
arg &	none (bool flag=true)
	Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args)

Public Attributes
object	value
	The default value.
const char *	descr
	The (optional) description of the default value.
std::string	type
	The C++ type name of the default value (only available when compiled in debug mode)
Public Attributes inherited from pybind11::arg
const char *	name
	If non-null, this is a named kwargs argument.
bool	flag_noconvert: 1
	If set, do not allow conversion (requires a supporting type caster!)
bool	flag_none: 1
	If set (the default), allow None to be passed to this argument.

Detailed Description

Annotation for arguments with values

---

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

• third_party/pybind11/include/pybind11/cast.h