nfx-serialization 0.3.0
Cross-platform C++ JSON serialization library with extensible trait capabilities
Loading...
Searching...
No Matches
nfx::serialization::json::Document::PathView::Iterator Class Reference

Forward iterator for path entries. More...

#include <nfx/serialization/json/Document.h>

Public Types

using iterator_category = std::forward_iterator_tag
 Iterator category tag for STL compatibility.
using value_type = Entry
 Type of value yielded by iterator.
using difference_type = std::ptrdiff_t
 Type for iterator difference.
using pointer = const Entry*
 Pointer to value type.
using reference = const Entry&
 Reference to value type.

Public Member Functions

 Iterator ()
 Default constructor - creates end iterator.
 Iterator (const std::vector< Entry > *entries, size_t index)
 Construct iterator at position.
reference operator* () const
 Dereference operator.
pointer operator-> () const
 Arrow operator.
Iteratoroperator++ ()
 Pre-increment operator.
Iterator operator++ (int)
 Post-increment operator.
bool operator== (const Iterator &other) const
 Equality comparison.
bool operator!= (const Iterator &other) const
 Inequality comparison.

Detailed Description

Forward iterator for path entries.

Definition at line 1256 of file Document.h.

Member Typedef Documentation

◆ difference_type

Type for iterator difference.

Definition at line 1264 of file Document.h.

◆ iterator_category

Iterator category tag for STL compatibility.

Definition at line 1260 of file Document.h.

◆ pointer

Pointer to value type.

Definition at line 1266 of file Document.h.

◆ reference

Reference to value type.

Definition at line 1268 of file Document.h.

◆ value_type

Type of value yielded by iterator.

Definition at line 1262 of file Document.h.

Constructor & Destructor Documentation

◆ Iterator() [1/2]

nfx::serialization::json::Document::PathView::Iterator::Iterator ( )
inline

Default constructor - creates end iterator.

Definition at line 1271 of file Document.h.

Here is the caller graph for this function:

◆ Iterator() [2/2]

nfx::serialization::json::Document::PathView::Iterator::Iterator ( const std::vector< Entry > * entries,
size_t index )
inline

Construct iterator at position.

Parameters
entriesPointer to entries vector
indexCurrent position

Definition at line 1282 of file Document.h.

Member Function Documentation

◆ operator!=()

bool nfx::serialization::json::Document::PathView::Iterator::operator!= ( const Iterator & other) const
inline

Inequality comparison.

Parameters
otherIterator to compare with
Returns
true if not equal

Definition at line 1348 of file Document.h.

Here is the call graph for this function:

◆ operator*()

reference nfx::serialization::json::Document::PathView::Iterator::operator* ( ) const
inline

Dereference operator.

Returns
Reference to current entry

Definition at line 1292 of file Document.h.

◆ operator++() [1/2]

Iterator & nfx::serialization::json::Document::PathView::Iterator::operator++ ( )
inline

Pre-increment operator.

Returns
Reference to this iterator

Definition at line 1304 of file Document.h.

Here is the call graph for this function:

◆ operator++() [2/2]

Iterator nfx::serialization::json::Document::PathView::Iterator::operator++ ( int )
inline

Post-increment operator.

Returns
Copy of iterator before increment

Definition at line 1314 of file Document.h.

Here is the call graph for this function:

◆ operator->()

pointer nfx::serialization::json::Document::PathView::Iterator::operator-> ( ) const
inline

Arrow operator.

Returns
Pointer to current entry

Definition at line 1298 of file Document.h.

◆ operator==()

bool nfx::serialization::json::Document::PathView::Iterator::operator== ( const Iterator & other) const
inline

Equality comparison.

Parameters
otherIterator to compare with
Returns
true if equal

Definition at line 1326 of file Document.h.

Here is the call graph for this function:

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