str Class Reference

#include <pytypes.h>

Inheritance diagram for str:

Public Member Functions
template<typename... Args>
str	format (Args &&...args) const
	operator std::string () const
	str (const bytes &b)
template<typename SzType , detail::enable_if_t< std::is_integral< SzType >::value, int > = 0>
	str (const char *c, const SzType &n)
	str (const char *c="")
	str (const std::string &s)
	str (handle h)
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...

Static Private Member Functions
static PyObject *	raw_str (PyObject *op)
	Return string representation – always returns a new reference, even if already a str. More...

Additional Inherited Members
Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()
Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

Definition at line 1558 of file pytypes.h.

Constructor & Destructor Documentation

str() [1/5]

template<typename SzType , detail::enable_if_t< std::is_integral< SzType >::value, int > = 0>

str::str ( const char *  c, const SzType &  n  )

inline

Definition at line 1563 of file pytypes.h.

str() [2/5]

str::str ( const char *  c = "" )

inline

Definition at line 1576 of file pytypes.h.

str() [3/5]

str::str ( const std::string &  s )

inline

Definition at line 1586 of file pytypes.h.

str() [4/5]

str::str ( const bytes &  b )

inlineexplicit

Definition at line 1738 of file pytypes.h.

str() [5/5]

str::str ( handle  h )

inlineexplicit

\rst Return a string representation of the object. This is analogous to the str() function in Python. \endrst

Definition at line 1608 of file pytypes.h.

Member Function Documentation

format()

template<typename... Args>

str str::format ( Args &&...  args ) const

inline

Definition at line 1632 of file pytypes.h.

operator std::string()

str::operator std::string ( ) const

inline

Definition at line 1615 of file pytypes.h.

raw_str()

static PyObject* str::raw_str ( PyObject *  op )

inlinestaticprivate

Return string representation – always returns a new reference, even if already a str.

Definition at line 1638 of file pytypes.h.

---

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

• pytypes.h