Project
Loading...
Searching...
No Matches
nlohmann::detail::iter_impl< BasicJsonType > Class Template Reference

a template for a bidirectional iterator for the basic_json class More...

#include <json.h>

Public Types

using iterator_category = std::bidirectional_iterator_tag
 
using value_type = typename BasicJsonType::value_type
 the type of the values when the iterator is dereferenced
 
using difference_type = typename BasicJsonType::difference_type
 a type to represent differences between iterators
 
using pointer = typename std::conditional< std::is_const< BasicJsonType >::value, typename BasicJsonType::const_pointer, typename BasicJsonType::pointer >::type
 defines a pointer to the type iterated over (value_type)
 
using reference = typename std::conditional< std::is_const< BasicJsonType >::value, typename BasicJsonType::const_reference, typename BasicJsonType::reference >::type
 defines a reference to the type iterated over (value_type)
 

Public Member Functions

 iter_impl ()=default
 default constructor
 
 iter_impl (pointer object) noexcept
 constructor for a given JSON instance
 
 iter_impl (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
 converting constructor
 
iter_imploperator= (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
 converting assignment
 
reference operator* () const
 return a reference to the value pointed to by the iterator
 
pointer operator-> () const
 dereference the iterator
 
iter_impl const operator++ (int)
 post-increment (it++)
 
iter_imploperator++ ()
 pre-increment (++it)
 
iter_impl const operator-- (int)
 post-decrement (it–)
 
iter_imploperator-- ()
 pre-decrement (–it)
 
bool operator== (const iter_impl &other) const
 comparison: equal
 
bool operator!= (const iter_impl &other) const
 comparison: not equal
 
bool operator< (const iter_impl &other) const
 comparison: smaller
 
bool operator<= (const iter_impl &other) const
 comparison: less than or equal
 
bool operator> (const iter_impl &other) const
 comparison: greater than
 
bool operator>= (const iter_impl &other) const
 comparison: greater than or equal
 
iter_imploperator+= (difference_type i)
 add to iterator
 
iter_imploperator-= (difference_type i)
 subtract from iterator
 
iter_impl operator+ (difference_type i) const
 add to iterator
 
iter_impl operator- (difference_type i) const
 subtract from iterator
 
difference_type operator- (const iter_impl &other) const
 return difference
 
reference operator[] (difference_type n) const
 access to successor
 
object_t::key_type key () const
 return the key of an object iterator
 
reference value () const
 return the value of an iterator
 

Friends

iter_impl operator+ (difference_type i, const iter_impl &it)
 addition of distance and iterator
 

Detailed Description

template<typename BasicJsonType>
class nlohmann::detail::iter_impl< BasicJsonType >

a template for a bidirectional iterator for the basic_json class

This class implements a both iterators (iterator and const_iterator) for the basic_json class.

Note
An iterator is called initialized when a pointer to a JSON value has been set (e.g., by a constructor or a copy assignment). If the iterator is default-constructed, it is uninitialized and most methods are undefined. The library uses assertions to detect calls on uninitialized iterators.**

@requirement The class satisfies the following concept requirements:

  • BidirectionalIterator: The iterator that can be moved can be moved in both directions (i.e. incremented and decremented).
Since
version 1.0.0, simplified in version 2.0.9, change to bidirectional iterators in version 3.0.0 (see https://github.com/nlohmann/json/issues/593)

Definition at line 3701 of file json.h.

Member Typedef Documentation

◆ difference_type

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::difference_type = typename BasicJsonType::difference_type

a type to represent differences between iterators

Definition at line 3725 of file json.h.

◆ iterator_category

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::iterator_category = std::bidirectional_iterator_tag

The std::iterator class template (used as a base class to provide typedefs) is deprecated in C++17. The C++ Standard has never required user-defined iterators to derive from std::iterator. A user-defined iterator should provide publicly accessible typedefs named iterator_category, value_type, difference_type, pointer, and reference. Note that value_type is required to be non-const, even for constant iterators.

Definition at line 3720 of file json.h.

◆ pointer

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::pointer = typename std::conditional<std::is_const<BasicJsonType>::value, typename BasicJsonType::const_pointer, typename BasicJsonType::pointer>::type

defines a pointer to the type iterated over (value_type)

Definition at line 3727 of file json.h.

◆ reference

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::reference = typename std::conditional<std::is_const<BasicJsonType>::value, typename BasicJsonType::const_reference, typename BasicJsonType::reference>::type

defines a reference to the type iterated over (value_type)

Definition at line 3731 of file json.h.

◆ value_type

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::value_type = typename BasicJsonType::value_type

the type of the values when the iterator is dereferenced

Definition at line 3723 of file json.h.

Constructor & Destructor Documentation

◆ iter_impl() [1/3]

template<typename BasicJsonType >
iter_impl< typename std::conditional< std::is_const< BasicJsonType >::value, typename std::remove_const< BasicJsonType >::type, const BasicJsonType >::type > ( )
default

default constructor

allow basic_json to access private members

Definition at line 3704 of file json.h.

◆ iter_impl() [2/3]

template<typename BasicJsonType >
nlohmann::detail::iter_impl< BasicJsonType >::iter_impl ( pointer  object)
inlineexplicitnoexcept

constructor for a given JSON instance

Parameters
[in]objectpointer to a JSON object for this iterator
Precondition
object != nullptr
Postcondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3745 of file json.h.

◆ iter_impl() [3/3]

template<typename BasicJsonType >
nlohmann::detail::iter_impl< BasicJsonType >::iter_impl ( const iter_impl< typename std::remove_const< BasicJsonType >::type > &  other)
inlinenoexcept

converting constructor

Note
The conventional copy constructor and copy assignment are implicitly defined. Combined with the following converting constructor and assignment, they support: (1) copy from iterator to iterator, (2) copy from const iterator to const iterator, and (3) conversion from iterator to const iterator. However conversion from const iterator to iterator is not defined.
Parameters
[in]othernon-const iterator to copy from
Note
It is not checked whether other is initialized.

Definition at line 3781 of file json.h.

Member Function Documentation

◆ key()

template<typename BasicJsonType >
object_t::key_type nlohmann::detail::iter_impl< BasicJsonType >::key ( ) const
inline

return the key of an object iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4202 of file json.h.

◆ operator!=()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator!= ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: not equal

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4025 of file json.h.

◆ operator*()

template<typename BasicJsonType >
reference nlohmann::detail::iter_impl< BasicJsonType >::operator* ( ) const
inline

return a reference to the value pointed to by the iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3861 of file json.h.

◆ operator+()

template<typename BasicJsonType >
iter_impl nlohmann::detail::iter_impl< BasicJsonType >::operator+ ( difference_type  i) const
inline

add to iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4121 of file json.h.

◆ operator++() [1/2]

template<typename BasicJsonType >
iter_impl & nlohmann::detail::iter_impl< BasicJsonType >::operator++ ( )
inline

pre-increment (++it)

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3933 of file json.h.

◆ operator++() [2/2]

template<typename BasicJsonType >
iter_impl const nlohmann::detail::iter_impl< BasicJsonType >::operator++ ( int  )
inline

post-increment (it++)

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3922 of file json.h.

◆ operator+=()

template<typename BasicJsonType >
iter_impl & nlohmann::detail::iter_impl< BasicJsonType >::operator+= ( difference_type  i)
inline

add to iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4086 of file json.h.

◆ operator-() [1/2]

template<typename BasicJsonType >
difference_type nlohmann::detail::iter_impl< BasicJsonType >::operator- ( const iter_impl< BasicJsonType > &  other) const
inline

return difference

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4154 of file json.h.

◆ operator-() [2/2]

template<typename BasicJsonType >
iter_impl nlohmann::detail::iter_impl< BasicJsonType >::operator- ( difference_type  i) const
inline

subtract from iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4143 of file json.h.

◆ operator--() [1/2]

template<typename BasicJsonType >
iter_impl & nlohmann::detail::iter_impl< BasicJsonType >::operator-- ( )
inline

pre-decrement (–it)

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3972 of file json.h.

◆ operator--() [2/2]

template<typename BasicJsonType >
iter_impl const nlohmann::detail::iter_impl< BasicJsonType >::operator-- ( int  )
inline

post-decrement (it–)

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3961 of file json.h.

◆ operator-=()

template<typename BasicJsonType >
iter_impl & nlohmann::detail::iter_impl< BasicJsonType >::operator-= ( difference_type  i)
inline

subtract from iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4112 of file json.h.

◆ operator->()

template<typename BasicJsonType >
pointer nlohmann::detail::iter_impl< BasicJsonType >::operator-> ( ) const
inline

dereference the iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 3893 of file json.h.

◆ operator<()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator< ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: smaller

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4034 of file json.h.

◆ operator<=()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator<= ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: less than or equal

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4059 of file json.h.

◆ operator=()

template<typename BasicJsonType >
iter_impl & nlohmann::detail::iter_impl< BasicJsonType >::operator= ( const iter_impl< typename std::remove_const< BasicJsonType >::type > &  other)
inlinenoexcept

converting assignment

Parameters
[in,out]othernon-const iterator to copy from
Returns
const/non-const iterator
Note
It is not checked whether other is initialized.

Definition at line 3790 of file json.h.

◆ operator==()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator== ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: equal

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4000 of file json.h.

◆ operator>()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator> ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: greater than

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4068 of file json.h.

◆ operator>=()

template<typename BasicJsonType >
bool nlohmann::detail::iter_impl< BasicJsonType >::operator>= ( const iter_impl< BasicJsonType > &  other) const
inline

comparison: greater than or equal

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4077 of file json.h.

◆ operator[]()

template<typename BasicJsonType >
reference nlohmann::detail::iter_impl< BasicJsonType >::operator[] ( difference_type  n) const
inline

access to successor

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4174 of file json.h.

◆ value()

template<typename BasicJsonType >
reference nlohmann::detail::iter_impl< BasicJsonType >::value ( ) const
inline

return the value of an iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4217 of file json.h.

Friends And Related Symbol Documentation

◆ operator+

template<typename BasicJsonType >
iter_impl operator+ ( difference_type  i,
const iter_impl< BasicJsonType > &  it 
)
friend

addition of distance and iterator

Precondition
The iterator is initialized; i.e. m_object != nullptr.

Definition at line 4132 of file json.h.


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