template<typename Iter>
py::key_iterator struct

Iterator adapter for accessing keys in map-like containers.

Template parameters
Iter The underlying iterator type for key-value pairs

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

Constructors, destructors, conversion operators

key_iterator(Iter it) explicit
Construct a key iterator from an underlying iterator.

Public functions

auto operator*() const -> const auto & -> auto
Dereference to get the key (const version)
auto operator*() -> const auto & -> auto
Dereference to get the key (non-const version)
auto operator++() -> key_iterator & -> auto
Pre-increment operator.
auto operator++(int) -> key_iterator -> auto
Post-increment operator.

Function documentation

template<typename Iter>
py::key_iterator<Iter>::key_iterator(Iter it) explicit

Construct a key iterator from an underlying iterator.

Parameters
it in The underlying iterator for key-value pairs

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

Dereference to get the key (const version)

Returns const auto& Reference to the key

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

Dereference to get the key (non-const version)

Returns const auto& Reference to the key

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

Pre-increment operator.

Returns key_iterator& Reference to this iterator

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

Post-increment operator.

Returns key_iterator Copy of this iterator before increment