μHAL (v2.8.17)
Part of the IPbus software repository
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Private Member Functions | List of all members
str Class Reference

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

Inheritance diagram for str:
[legend]
Collaboration diagram for str:
[legend]

Public Member Functions

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 (const bytes &b)
 
 str (handle h)
 \rst Return a string representation of the object. More...
 
 operator std::string () const
 
template<typename... Args>
str format (Args &&...args) const
 
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 (const bytes &b)
 
 str (handle h)
 \rst Return a string representation of the object. More...
 
 operator std::string () const
 
template<typename... Args>
str format (Args &&...args) const
 
- Public Member Functions inherited from object
 object ()=default
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
handle release ()
 \rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
 object ()=default
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
handle release ()
 \rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
template<>
void cast () const &
 
template<>
void cast () &&
 
- Public Member Functions inherited from handle
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer. More...
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 
const handleinc_ref () const &
 \rst Manually increase the reference count of the Python object. More...
 
const handledec_ref () const &
 \rst Manually decrease the reference count of the Python object. More...
 
template<typename T >
cast () const
 \rst Attempt to cast the Python object into the given C++ type. More...
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator== (const handle &h) const
 \rst Deprecated: Check that the underlying pointers are the same. More...
 
bool operator!= (const handle &h) const
 
bool check () const
 
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
 handle (T ptr)
 Enable implicit conversion from PyObject * and nullptr. 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...
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 
const handleinc_ref () const &
 \rst Manually increase the reference count of the Python object. More...
 
const handledec_ref () const &
 \rst Manually decrease the reference count of the Python object. More...
 
template<typename T >
cast () const
 \rst Attempt to cast the Python object into the given C++ type. More...
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator== (const handle &h) const
 \rst Deprecated: Check that the underlying pointers are the same. More...
 
bool operator!= (const handle &h) const
 
bool check () const
 
template<>
void cast () const
 

Static Private Member Functions

static PyObject * raw_str (PyObject *op)
 Return string representation – always returns a new reference, even if already a str. More...
 
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 1200 of file pytypes.h.

Constructor & Destructor Documentation

◆ str() [1/10]

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 1205 of file pytypes.h.

References handle::m_ptr, and pybind11_fail().

◆ str() [2/10]

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

Definition at line 1215 of file pytypes.h.

References handle::m_ptr, and pybind11_fail().

◆ str() [3/10]

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

Definition at line 1222 of file pytypes.h.

◆ str() [4/10]

str::str ( const bytes b)
inlineexplicit

◆ str() [5/10]

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 1244 of file pytypes.h.

References handle::m_ptr.

◆ str() [6/10]

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 1470 of file pytypes.h.

References handle::m_ptr, and pybind11_fail().

◆ str() [7/10]

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

Definition at line 1483 of file pytypes.h.

References handle::m_ptr, and pybind11_fail().

◆ str() [8/10]

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

Definition at line 1493 of file pytypes.h.

◆ str() [9/10]

str::str ( const bytes b)
explicit

◆ str() [10/10]

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 1515 of file pytypes.h.

References handle::m_ptr.

Member Function Documentation

◆ format() [1/2]

template<typename... Args>
str str::format ( Args &&...  args) const
inline

Definition at line 1268 of file pytypes.h.

◆ format() [2/2]

template<typename... Args>
str str::format ( Args &&...  args) const
inline

Definition at line 1539 of file pytypes.h.

◆ operator std::string() [1/2]

str::operator std::string ( ) const
inline

◆ operator std::string() [2/2]

str::operator std::string ( ) const
inline

◆ raw_str() [1/2]

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

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

Definition at line 1274 of file pytypes.h.

◆ raw_str() [2/2]

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

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

Definition at line 1545 of file pytypes.h.


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