msgpack_light::const_array_iterator Class Reference

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

#include <msgpack_light/details/array_iterator.h>

Collaboration diagram for msgpack_light::const_array_iterator:

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

Public Member Functions
	const_array_iterator () noexcept
	Constructor.
	const_array_iterator (const details::object_data *pointer) noexcept
	Constructor.
const_object_ref	operator* () const noexcept
	Dereference this iterator.
const_array_iterator &	operator++ () noexcept
	Increment this iterator.
const const_array_iterator	operator++ (int) noexcept
	Increment this iterator.

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

Detailed Description

Class of iterators of arrays to access constant objects.

Note

Instances of this class can be created from msgpack_light::const_array_ref, msgpack_light::mutable_array_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 118 of file array_iterator.h.

Member Typedef Documentation

difference_type

using msgpack_light::const_array_iterator::difference_type = std::ptrdiff_t

Type of differences.

Definition at line 121 of file array_iterator.h.

reference

using msgpack_light::const_array_iterator::reference = const_object_ref

Type of references.

Definition at line 127 of file array_iterator.h.

value_type

using msgpack_light::const_array_iterator::value_type = const_object_ref

Type of values.

Definition at line 124 of file array_iterator.h.

Constructor & Destructor Documentation

const_array_iterator() [1/2]

msgpack_light::const_array_iterator::const_array_iterator ( )

inlinenoexcept

Constructor.

Definition at line 132 of file array_iterator.h.

const_array_iterator() [2/2]

msgpack_light::const_array_iterator::const_array_iterator ( const details::object_data * pointer )

inlineexplicitnoexcept

Constructor.

Parameters

[in]

pointer

Pointer to the current data.

Definition at line 139 of file array_iterator.h.

Member Function Documentation

operator*()

const_object_ref msgpack_light::const_array_iterator::operator* ( ) const

inlinenoexcept

Dereference this iterator.

Returns

Reference to the current object.

Definition at line 71 of file array_iterator_impl.h.

operator++() [1/2]

const_array_iterator & msgpack_light::const_array_iterator::operator++ ( )

inlinenoexcept

Increment this iterator.

Returns

This iterator.

Definition at line 154 of file array_iterator.h.

operator++() [2/2]

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

inlinenoexcept

Increment this iterator.

Returns

This iterator.

Definition at line 165 of file array_iterator.h.

Member Data Documentation

pointer_

const details::object_data* msgpack_light::const_array_iterator::pointer_

private

Pointer to the current data.

Definition at line 173 of file array_iterator.h.

---

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

• include/msgpack_light/details/array_iterator.h
• include/msgpack_light/details/array_iterator_impl.h