capsule Class Reference

#include <pytypes.h>

Inheritance diagram for capsule:

Public Member Functions
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<capsule>() or reinterpret_steal<capsule>()") capsule(PyObject *ptr
Public Member Functions inherited from object
template<typename T >
T	cast () &&
template<typename T >
T	cast () const &
template<>
void	cast () const &
	object ()=default
	object (const object &o)
	Copy constructor; always increases the reference count. More...
	object (handle h, borrowed_t)
	object (handle h, stolen_t)
	object (object &&other) noexcept
	Move constructor; steals the object from other and preserves its reference count. More...
object &	operator= (const object &other)
object &	operator= (object &&other) noexcept
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
handle	release ()
	~object ()
	Destructor; automatically calls handle::dec_ref() More...
Public Member Functions inherited from handle
template<typename T >
T	cast () const
template<>
void	cast () const
bool	check () const
const handle &	dec_ref () const &
	handle ()=default
	The default constructor creates a handle with a nullptr-valued pointer. More...
template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T >>, std::is_convertible< T, PyObject * >>::value, int > = 0>
	handle (T &obj)
	Enable implicit conversion through T::operator PyObject *(). More...
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
	handle (T ptr)
const handle &	inc_ref () const &
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator!= (const handle &h) const
bool	operator== (const handle &h) const
PyObject *&	ptr ()
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...

Public Attributes
bool	is_borrowed: object(is_borrowed ? object(ptr
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()

Additional Inherited Members
Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()
Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

Definition at line 1951 of file pytypes.h.

Member Function Documentation

PYBIND11_DEPRECATED()

capsule::PYBIND11_DEPRECATED

(

"Use reinterpret_borrow<capsule>() or reinterpret_steal<capsule>()"

)

Member Data Documentation

is_borrowed

bool capsule::is_borrowed

Definition at line 1956 of file pytypes.h.

---

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

• pytypes.h