Scarab  v2.11.1
Project 8 C++ Utility Library
Protected Types | Protected Member Functions | Private Attributes | List of all members
dict_readonly Class Reference

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

#include <pytypes.h>

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 >
 

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
 

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

Member Typedef Documentation

◆ iterator_category

using iterator_category = std::forward_iterator_tag
protected

Definition at line 697 of file pytypes.h.

◆ pointer

using pointer = arrow_proxy<const value_type>
protected

Definition at line 700 of file pytypes.h.

◆ reference

using reference = const value_type
protected

Definition at line 699 of file pytypes.h.

◆ value_type

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

Definition at line 698 of file pytypes.h.

Constructor & Destructor Documentation

◆ dict_readonly() [1/2]

dict_readonly ( )
protecteddefault

◆ dict_readonly() [2/2]

dict_readonly ( handle  obj,
ssize_t  pos 
)
inlineprotected

Definition at line 703 of file pytypes.h.

Member Function Documentation

◆ dereference()

reference dereference ( ) const
inlineprotected

Definition at line 705 of file pytypes.h.

◆ equal()

bool equal ( const dict_readonly b) const
inlineprotected

Definition at line 707 of file pytypes.h.

◆ increment()

void increment ( )
inlineprotected

Definition at line 706 of file pytypes.h.

Member Data Documentation

◆ key

PyObject* key = nullptr
private

Definition at line 711 of file pytypes.h.

◆ obj

handle obj
private

Definition at line 710 of file pytypes.h.

◆ pos

ssize_t pos = -1
private

Definition at line 712 of file pytypes.h.

◆ value

PyObject * value = nullptr
private

Definition at line 711 of file pytypes.h.


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