dict_readonly Class Reference

Python's dictionary protocol permits this to be a forward iterator. More...

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

Collaboration diagram for dict_readonly:

Protected Types
using	iterator_category = std::forward_iterator_tag
using	value_type = std::pair< handle, handle >
using	reference = const value_type
using	pointer = arrow_proxy< const value_type >
using	iterator_category = std::forward_iterator_tag
using	value_type = std::pair< handle, handle >
using	reference = const value_type
using	pointer = arrow_proxy< const value_type >

Protected Member Functions
	dict_readonly ()=default
	dict_readonly (handle obj, ssize_t pos)
reference	dereference () const
void	increment ()
bool	equal (const dict_readonly &b) const
	dict_readonly ()=default
	dict_readonly (handle obj, ssize_t pos)
reference	dereference () const
void	increment ()
bool	equal (const dict_readonly &b) const

Private Attributes
handle	obj
PyObject *	key = nullptr
PyObject *	value = nullptr
ssize_t	pos = -1

Detailed Description

Python's dictionary protocol permits this to be a forward iterator.

Definition at line 940 of file pytypes.h.

Member Typedef Documentation

iterator_category [1/2]

using dict_readonly::iterator_category = std::forward_iterator_tag

protected

Definition at line 942 of file pytypes.h.

iterator_category [2/2]

using dict_readonly::iterator_category = std::forward_iterator_tag

protected

Definition at line 1207 of file pytypes.h.

pointer [1/2]

using dict_readonly::pointer = arrow_proxy<const value_type>

protected

Definition at line 945 of file pytypes.h.

pointer [2/2]

using dict_readonly::pointer = arrow_proxy<const value_type>

protected

Definition at line 1210 of file pytypes.h.

reference [1/2]

using dict_readonly::reference = const value_type

protected

Definition at line 944 of file pytypes.h.

reference [2/2]

using dict_readonly::reference = const value_type

protected

Definition at line 1209 of file pytypes.h.

value_type [1/2]

using dict_readonly::value_type = std::pair<handle, handle>

protected

Definition at line 943 of file pytypes.h.

value_type [2/2]

using dict_readonly::value_type = std::pair<handle, handle>

protected

Definition at line 1208 of file pytypes.h.

Constructor & Destructor Documentation

dict_readonly() [1/4]

dict_readonly::dict_readonly ( )

protecteddefault

dict_readonly() [2/4]

dict_readonly::dict_readonly ( handle  obj, ssize_t  pos  )

inlineprotected

Definition at line 948 of file pytypes.h.

References increment().

dict_readonly() [3/4]

dict_readonly::dict_readonly ( )

protecteddefault

dict_readonly() [4/4]

dict_readonly::dict_readonly ( handle  obj, ssize_t  pos  )

inlineprotected

Definition at line 1213 of file pytypes.h.

References increment().

Member Function Documentation

dereference() [1/2]

reference dict_readonly::dereference ( ) const

inlineprotected

Definition at line 951 of file pytypes.h.

References key, and value.

dereference() [2/2]

reference dict_readonly::dereference ( ) const

inlineprotected

Definition at line 1216 of file pytypes.h.

References key, and value.

equal() [1/2]

bool dict_readonly::equal ( const dict_readonly &  b ) const

inlineprotected

Definition at line 957 of file pytypes.h.

References pos.

equal() [2/2]

bool dict_readonly::equal ( const dict_readonly &  b ) const

inlineprotected

Definition at line 1222 of file pytypes.h.

References pos.

increment() [1/2]

void dict_readonly::increment ( )

inlineprotected

Definition at line 952 of file pytypes.h.

References key, obj, pos, handle::ptr(), and value.

Referenced by dict_readonly().

increment() [2/2]

void dict_readonly::increment ( )

inlineprotected

Definition at line 1217 of file pytypes.h.

References key, obj, pos, handle::ptr(), and value.

Member Data Documentation

key

PyObject * dict_readonly::key = nullptr

private

Definition at line 961 of file pytypes.h.

Referenced by dereference(), and increment().

obj

handle dict_readonly::obj

private

Definition at line 960 of file pytypes.h.

Referenced by increment().

pos

ssize_t dict_readonly::pos = -1

private

Definition at line 962 of file pytypes.h.

Referenced by equal(), and increment().

value

PyObject * dict_readonly::value = nullptr

private

Definition at line 961 of file pytypes.h.

Referenced by dereference(), and increment().

---

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

• python/pybind11-python2/include/pybind11/pytypes.h
• python/pybind11/include/pybind11/pytypes.h