msgpack_light::const_map_iterator Class Reference

Class of iterators of maps to access constant objects. More...

#include <msgpack_light/details/map_iterator.h>

Collaboration diagram for msgpack_light::const_map_iterator:

Public Types
using	difference_type = std::ptrdiff_t
	Type of differences.
using	reference = value_type
	Type of references.
using	value_type = std::pair<const_object_ref, const_object_ref>
	Type of values.

Public Member Functions
	const_map_iterator () noexcept
	Constructor.
	const_map_iterator (const details::key_value_pair_data *pointer) noexcept
	Constructor.
std::pair< const_object_ref, const_object_ref >	operator* () const noexcept
	Dereference this iterator.
const_map_iterator &	operator++ () noexcept
	Increment this iterator.
const const_map_iterator	operator++ (int) noexcept
	Increment this iterator.

Private Attributes
const details::key_value_pair_data *	pointer_
	Pointer to the current data.

Detailed Description

Class of iterators of maps to access constant objects.

Note

Instances of this class can be created from msgpack_light::const_map_ref, msgpack_light::mutable_map_ref classes.

Warning

This class only holds pointers to data in msgpack_light::object class, do not call functions in this class without msgpack_light::object instances holding the data.

Definition at line 120 of file map_iterator.h.

Member Typedef Documentation

difference_type

using msgpack_light::const_map_iterator::difference_type = std::ptrdiff_t

Type of differences.

Definition at line 123 of file map_iterator.h.

reference

using msgpack_light::const_map_iterator::reference = value_type

Type of references.

Definition at line 129 of file map_iterator.h.

value_type

using msgpack_light::const_map_iterator::value_type = std::pair<const_object_ref, const_object_ref>

Type of values.

Definition at line 126 of file map_iterator.h.

Constructor & Destructor Documentation

const_map_iterator() [1/2]

msgpack_light::const_map_iterator::const_map_iterator ( )

inlinenoexcept

Constructor.

Definition at line 134 of file map_iterator.h.

const_map_iterator() [2/2]

msgpack_light::const_map_iterator::const_map_iterator ( const details::key_value_pair_data * pointer )

inlineexplicitnoexcept

Constructor.

Parameters

[in]

pointer

Pointer to the current data.

Definition at line 141 of file map_iterator.h.

Member Function Documentation

operator*()

std::pair< const_object_ref, const_object_ref > msgpack_light::const_map_iterator::operator* ( ) const

inlinenoexcept

Dereference this iterator.

Returns

References to the current key and value.

Definition at line 76 of file map_iterator_impl.h.

operator++() [1/2]

const_map_iterator & msgpack_light::const_map_iterator::operator++ ( )

inlinenoexcept

Increment this iterator.

Returns

This iterator.

Definition at line 157 of file map_iterator.h.

operator++() [2/2]

const const_map_iterator msgpack_light::const_map_iterator::operator++ ( int )

inlinenoexcept

Increment this iterator.

Returns

This iterator.

Definition at line 168 of file map_iterator.h.

Member Data Documentation

pointer_

const details::key_value_pair_data* msgpack_light::const_map_iterator::pointer_

private

Pointer to the current data.

Definition at line 176 of file map_iterator.h.

---

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

• include/msgpack_light/details/map_iterator.h
• include/msgpack_light/details/map_iterator_impl.h