py::key_iterator< Iter > Struct Template Reference

Iterator adapter for accessing keys in map-like containers. More...

#include <dict.hpp>

Inheritance diagram for py::key_iterator< Iter >:

Collaboration diagram for py::key_iterator< Iter >:

Public Member Functions
	key_iterator (Iter it)
	Construct a key iterator from an underlying iterator.
auto	operator* () const -> const auto &
	Dereference to get the key (const version)
auto	operator* () -> const auto &
	Dereference to get the key (non-const version)
auto	operator++ () -> key_iterator &
	Pre-increment operator.
auto	operator++ (int) -> key_iterator
	Post-increment operator.

Detailed Description

template<typename Iter>
struct py::key_iterator< Iter >

Iterator adapter for accessing keys in map-like containers.

Provides an iterator that dereferences to the key component of key-value pairs in map-like containers.

Template Parameters

Iter	The underlying iterator type for key-value pairs

Constructor & Destructor Documentation

key_iterator()

template<typename Iter >

py::key_iterator< Iter >::key_iterator ( Iter  it )

inlineexplicit

Construct a key iterator from an underlying iterator.

Parameters

[in]

it

The underlying iterator for key-value pairs

Member Function Documentation

operator*() [1/2]

template<typename Iter >

auto py::key_iterator< Iter >::operator* ( ) -> const auto&

inline

Dereference to get the key (non-const version)

Returns

const auto& Reference to the key

operator*() [2/2]

template<typename Iter >

auto py::key_iterator< Iter >::operator* ( ) const -> const auto&

inline

Dereference to get the key (const version)

Returns

const auto& Reference to the key

operator++() [1/2]

template<typename Iter >

auto py::key_iterator< Iter >::operator++ ( ) -> key_iterator&

inline

Pre-increment operator.

Returns

key_iterator& Reference to this iterator

operator++() [2/2]

template<typename Iter >

auto py::key_iterator< Iter >::operator++ ( int  ) -> key_iterator

inline

Post-increment operator.

Returns

key_iterator Copy of this iterator before increment

---

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

• py2cpp/dict.hpp