μHAL (v2.8.17)
Part of the IPbus software repository
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
copyable_holder_caster< type, holder_type, SFINAE > Struct Template Reference

Type caster for holder types like std::shared_ptr, etc. More...

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

Inheritance diagram for copyable_holder_caster< type, holder_type, SFINAE >:
[legend]
Collaboration diagram for copyable_holder_caster< type, holder_type, SFINAE >:
[legend]

Public Types

using base = type_caster_base< type >
 
using base = type_caster_base< type >
 
- Public Types inherited from type_caster_base< type >
template<typename T >
using cast_op_type = detail::cast_op_type< T >
 
template<typename T >
using cast_op_type = detail::cast_op_type< T >
 

Public Member Functions

bool load (handle src, bool convert)
 
 operator type * ()
 
 operator type & ()
 
 operator holder_type * ()
 
 operator holder_type & ()
 
bool load (handle src, bool convert)
 
 operator type * ()
 
 operator type & ()
 
 operator holder_type * ()
 
 operator holder_type & ()
 
- Public Member Functions inherited from type_caster_base< type >
 type_caster_base ()
 
 type_caster_base (const std::type_info &info)
 
 operator itype * ()
 
 operator itype & ()
 
 type_caster_base ()
 
 type_caster_base (const std::type_info &info)
 
 operator itype * ()
 
 operator itype & ()
 
- Public Member Functions inherited from type_caster_generic
PYBIND11_NOINLINE type_caster_generic (const std::type_info &type_info)
 
 type_caster_generic (const type_info *typeinfo)
 
bool load (handle src, bool convert)
 
void load_value (value_and_holder &&v_h)
 
bool try_implicit_casts (handle src, bool convert)
 
bool try_direct_conversions (handle src)
 
void check_holder_compat ()
 
PYBIND11_NOINLINE bool try_load_foreign_module_local (handle src)
 Try to load with foreign typeinfo, if available. More...
 
template<typename ThisT >
PYBIND11_NOINLINE bool load_impl (handle src, bool convert)
 
PYBIND11_NOINLINE type_caster_generic (const std::type_info &type_info)
 
 type_caster_generic (const type_info *typeinfo)
 
bool load (handle src, bool convert)
 
void load_value (value_and_holder &&v_h)
 
bool try_implicit_casts (handle src, bool convert)
 
bool try_direct_conversions (handle src)
 
void check_holder_compat ()
 
PYBIND11_NOINLINE bool try_load_foreign_module_local (handle src)
 Try to load with foreign typeinfo, if available. More...
 
template<typename ThisT >
PYBIND11_NOINLINE bool load_impl (handle src, bool convert)
 

Static Public Member Functions

static handle cast (const holder_type &src, return_value_policy, handle)
 
static handle cast (const holder_type &src, return_value_policy, handle)
 
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
- Static Public Member Functions inherited from type_caster_base< type >
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static std::pair< const void *, const type_info * > src_and_type (const itype *src)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
static handle cast_holder (const itype *src, const void *holder)
 
static handle cast (const itype &src, return_value_policy policy, handle parent)
 
static handle cast (itype &&src, return_value_policy, handle parent)
 
static std::pair< const void *, const type_info * > src_and_type (const itype *src)
 
static handle cast (const itype *src, return_value_policy policy, handle parent)
 
static handle cast_holder (const itype *src, const void *holder)
 
- Static Public Member Functions inherited from type_caster_generic
static PYBIND11_NOINLINE handle cast (const void *_src, return_value_policy policy, handle parent, const detail::type_info *tinfo, void *(*copy_constructor)(const void *), void *(*move_constructor)(const void *), const void *existing_holder=nullptr)
 
static PYBIND11_NOINLINE void * local_load (PyObject *src, const type_info *ti)
 
static PYBIND11_NOINLINE std::pair< const void *, const type_info * > src_and_type (const void *src, const std::type_info &cast_type, const std::type_info *rtti_type=nullptr)
 
static PYBIND11_NOINLINE handle cast (const void *_src, return_value_policy policy, handle parent, const detail::type_info *tinfo, void *(*copy_constructor)(const void *), void *(*move_constructor)(const void *), const void *existing_holder=nullptr)
 
static PYBIND11_NOINLINE void * local_load (PyObject *src, const type_info *ti)
 
static PYBIND11_NOINLINE std::pair< const void *, const type_info * > src_and_type (const void *src, const std::type_info &cast_type, const std::type_info *rtti_type=nullptr)
 

Protected Member Functions

void check_holder_compat ()
 
bool load_value (value_and_holder &&v_h)
 
template<typename T = holder_type, detail::enable_if_t<!std::is_constructible< T, const T &, type * >::value, int > = 0>
bool try_implicit_casts (handle, bool)
 
template<typename T = holder_type, detail::enable_if_t< std::is_constructible< T, const T &, type * >::value, int > = 0>
bool try_implicit_casts (handle src, bool convert)
 
void check_holder_compat ()
 
bool load_value (value_and_holder &&v_h)
 
template<typename T = holder_type, detail::enable_if_t<!std::is_constructible< T, const T &, type * >::value, int > = 0>
bool try_implicit_casts (handle, bool)
 
template<typename T = holder_type, detail::enable_if_t< std::is_constructible< T, const T &, type * >::value, int > = 0>
bool try_implicit_casts (handle src, bool convert)
 

Static Protected Member Functions

static bool try_direct_conversions (handle)
 
static bool try_direct_conversions (handle)
 
- Static Protected Member Functions inherited from type_caster_base< type >
template<typename T , typename = enable_if_t<is_copy_constructible<T>::value>>
static auto make_copy_constructor (const T *) -> decltype(new T(std::declval< const T >()), Constructor{})
 
template<typename T , typename = enable_if_t<std::is_move_constructible<T>::value>>
static auto make_move_constructor (const T *) -> decltype(new T(std::declval< T && >()), Constructor{})
 
static Constructor make_copy_constructor (...)
 
static Constructor make_move_constructor (...)
 
template<typename T , typename = enable_if_t<is_copy_constructible<T>::value>>
static auto make_copy_constructor (const T *) -> decltype(new T(std::declval< const T >()), Constructor{})
 
template<typename T , typename = enable_if_t<std::is_move_constructible<T>::value>>
static auto make_move_constructor (const T *) -> decltype(new T(std::declval< T && >()), Constructor{})
 
static Constructor make_copy_constructor (...)
 
static Constructor make_move_constructor (...)
 

Protected Attributes

holder_type holder
 

Friends

class type_caster_generic
 

Additional Inherited Members

- Public Attributes inherited from type_caster_generic
const type_info * typeinfo = nullptr
 
const std::type_info * cpptype = nullptr
 
void * value = nullptr
 
- Static Public Attributes inherited from type_caster_base< type >
static constexpr auto name = const_name<type>()
 
- Protected Types inherited from type_caster_base< type >
using Constructor = void *(*)(const void *)
 
using Constructor = void *(*)(const void *)
 

Detailed Description

template<typename type, typename holder_type, typename SFINAE = void>
struct copyable_holder_caster< type, holder_type, SFINAE >

Type caster for holder types like std::shared_ptr, etc.

The SFINAE hook is provided to help work around the current lack of support for smart-pointer interoperability. Please consider it an implementation detail that may change in the future, as formal support for smart-pointer interoperability is added into pybind11.

Definition at line 750 of file cast.h.

Member Typedef Documentation

◆ base [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
using copyable_holder_caster< type, holder_type, SFINAE >::base = type_caster_base<type>

Definition at line 752 of file cast.h.

◆ base [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
using copyable_holder_caster< type, holder_type, SFINAE >::base = type_caster_base<type>

Definition at line 745 of file cast.h.

Member Function Documentation

◆ cast() [1/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle copyable_holder_caster< type, holder_type, SFINAE >::cast ( const holder_type &  src,
return_value_policy  ,
handle   
)
inlinestatic

Definition at line 771 of file cast.h.

References type_caster_base< type >::cast_holder(), and holder_helper< T >::get().

Referenced by copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts().

◆ cast() [2/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle copyable_holder_caster< type, holder_type, SFINAE >::cast ( const holder_type &  src,
return_value_policy  ,
handle   
)
inlinestatic

Definition at line 764 of file cast.h.

References type_caster_base< type >::cast_holder(), and holder_helper< T >::get().

◆ cast() [3/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype &  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 914 of file type_caster_base.h.

◆ cast() [4/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype &  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 987 of file type_caster_base.h.

◆ cast() [5/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype &  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 914 of file type_caster_base.h.

◆ cast() [6/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype &  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 987 of file type_caster_base.h.

◆ cast() [7/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype *  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 951 of file type_caster_base.h.

◆ cast() [8/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype *  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 1024 of file type_caster_base.h.

◆ cast() [9/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype *  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 951 of file type_caster_base.h.

◆ cast() [10/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( const itype *  src,
return_value_policy  policy,
handle  parent 
)
inlinestatic

Definition at line 1024 of file type_caster_base.h.

◆ cast() [11/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( itype &&  src,
return_value_policy  ,
handle  parent 
)
inlinestatic

Definition at line 922 of file type_caster_base.h.

◆ cast() [12/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( itype &&  src,
return_value_policy  ,
handle  parent 
)
inlinestatic

Definition at line 995 of file type_caster_base.h.

◆ cast() [13/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( itype &&  src,
return_value_policy  ,
handle  parent 
)
inlinestatic

Definition at line 922 of file type_caster_base.h.

◆ cast() [14/14]

template<typename type , typename holder_type , typename SFINAE = void>
static handle type_caster_base< type >::cast ( itype &&  src,
return_value_policy  ,
handle  parent 
)
inlinestatic

Definition at line 995 of file type_caster_base.h.

◆ check_holder_compat() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
void copyable_holder_caster< type, holder_type, SFINAE >::check_holder_compat ( )
inlineprotected

Definition at line 778 of file cast.h.

References type_info::default_holder, and type_caster_generic::typeinfo.

◆ check_holder_compat() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
void copyable_holder_caster< type, holder_type, SFINAE >::check_holder_compat ( )
inlineprotected

Definition at line 771 of file cast.h.

References type_info::default_holder, and type_caster_generic::typeinfo.

◆ load() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
bool copyable_holder_caster< type, holder_type, SFINAE >::load ( handle  src,
bool  convert 
)
inline

Definition at line 760 of file cast.h.

Referenced by copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts().

◆ load() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
bool copyable_holder_caster< type, holder_type, SFINAE >::load ( handle  src,
bool  convert 
)
inline

Definition at line 753 of file cast.h.

◆ load_value() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
bool copyable_holder_caster< type, holder_type, SFINAE >::load_value ( value_and_holder &&  v_h)
inlineprotected

Definition at line 784 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder, and type_caster_generic::value.

◆ load_value() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
bool copyable_holder_caster< type, holder_type, SFINAE >::load_value ( value_and_holder &&  v_h)
inlineprotected

Definition at line 777 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder, PYBIND11_DETAILED_ERROR_MESSAGES, and type_caster_generic::value.

◆ operator holder_type &() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type & ( )
inlineexplicit

Definition at line 769 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder.

◆ operator holder_type &() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type & ( )
inlineexplicit

Definition at line 762 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder.

◆ operator holder_type *() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type * ( )
inlineexplicit

Definition at line 768 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder.

◆ operator holder_type *() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type * ( )
inlineexplicit

Definition at line 761 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::holder.

◆ operator type &() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator type & ( )
inlineexplicit

Definition at line 767 of file cast.h.

◆ operator type &() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator type & ( )
inlineexplicit

Definition at line 760 of file cast.h.

◆ operator type *() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator type * ( )
inlineexplicit

Definition at line 764 of file cast.h.

◆ operator type *() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
copyable_holder_caster< type, holder_type, SFINAE >::operator type * ( )
inlineexplicit

Definition at line 757 of file cast.h.

◆ try_direct_conversions() [1/2]

template<typename type , typename holder_type , typename SFINAE = void>
static bool copyable_holder_caster< type, holder_type, SFINAE >::try_direct_conversions ( handle  )
inlinestaticprotected

Definition at line 819 of file cast.h.

◆ try_direct_conversions() [2/2]

template<typename type , typename holder_type , typename SFINAE = void>
static bool copyable_holder_caster< type, holder_type, SFINAE >::try_direct_conversions ( handle  )
inlinestaticprotected

Definition at line 813 of file cast.h.

◆ try_implicit_casts() [1/4]

template<typename type , typename holder_type , typename SFINAE = void>
template<typename T = holder_type, detail::enable_if_t< std::is_constructible< T, const T &, type * >::value, int > = 0>
bool copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts ( handle  src,
bool  convert 
)
inlineprotected

Definition at line 807 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::cast(), copyable_holder_caster< type, holder_type, SFINAE >::holder, type_info::implicit_casts, copyable_holder_caster< type, holder_type, SFINAE >::load(), type_caster_generic::typeinfo, and type_caster_generic::value.

◆ try_implicit_casts() [2/4]

template<typename type , typename holder_type , typename SFINAE = void>
template<typename T = holder_type, detail::enable_if_t< std::is_constructible< T, const T &, type * >::value, int > = 0>
bool copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts ( handle  src,
bool  convert 
)
inlineprotected

Definition at line 801 of file cast.h.

References copyable_holder_caster< type, holder_type, SFINAE >::cast(), copyable_holder_caster< type, holder_type, SFINAE >::holder, type_info::implicit_casts, copyable_holder_caster< type, holder_type, SFINAE >::load(), type_caster_generic::typeinfo, and type_caster_generic::value.

◆ try_implicit_casts() [3/4]

template<typename type , typename holder_type , typename SFINAE = void>
template<typename T = holder_type, detail::enable_if_t<!std::is_constructible< T, const T &, type * >::value, int > = 0>
bool copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts ( handle  ,
bool   
)
inlineprotected

Definition at line 801 of file cast.h.

◆ try_implicit_casts() [4/4]

template<typename type , typename holder_type , typename SFINAE = void>
template<typename T = holder_type, detail::enable_if_t<!std::is_constructible< T, const T &, type * >::value, int > = 0>
bool copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts ( handle  ,
bool   
)
inlineprotected

Definition at line 795 of file cast.h.

Friends And Related Function Documentation

◆ type_caster_generic

template<typename type , typename holder_type , typename SFINAE = void>
type_caster_generic
friend

Definition at line 777 of file cast.h.

Member Data Documentation

◆ holder

template<typename type , typename holder_type , typename SFINAE = void>
holder_type copyable_holder_caster< type, holder_type, SFINAE >::holder
protected

Definition at line 821 of file cast.h.

Referenced by copyable_holder_caster< type, holder_type, SFINAE >::load_value(), copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type &(), copyable_holder_caster< type, holder_type, SFINAE >::operator holder_type *(), and copyable_holder_caster< type, holder_type, SFINAE >::try_implicit_casts().

The documentation for this struct was generated from the following files:
Generated on Sat Mar 15 2025 17:14:14 for μHAL (v2.8.17) by doxygen 1.9.5