Crossfire Server, Trunk
nlohmann::detail::iter_impl< BasicJsonType > Class Template Reference

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. More...

#include <json.hpp>

+ Collaboration diagram for nlohmann::detail::iter_impl< BasicJsonType >:

Public Types

using difference_type = typename BasicJsonType::difference_type
 a type to represent differences between iterators More...
 
using iterator_category = std::bidirectional_iterator_tag
 
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) More...
 
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) More...
 
using value_type = typename BasicJsonType::value_type
 the type of the values when the iterator is dereferenced More...
 

Public Member Functions

 iter_impl ()=default
 
 iter_impl (const iter_impl< const BasicJsonType > &other) noexcept
 const copy constructor More...
 
 iter_impl (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
 converting constructor More...
 
 iter_impl (iter_impl &&) noexcept=default
 
 iter_impl (pointer object) noexcept
 constructor for a given JSON instance More...
 
const object_t::key_type & key () const
 return the key of an object iterator More...
 
template<typename IterImpl , detail::enable_if_t<(std::is_same< IterImpl, iter_impl >::value||std::is_same< IterImpl, other_iter_impl >::value), std::nullptr_t > = nullptr>
bool operator!= (const IterImpl &other) const
 comparison: not equal More...
 
reference operator* () const
 return a reference to the value pointed to by the iterator More...
 
iter_impl operator+ (difference_type i) const
 add to iterator More...
 
iter_imploperator++ ()
 pre-increment (++it) More...
 
const iter_impl operator++ (int)
 post-increment (it++) More...
 
iter_imploperator+= (difference_type i)
 add to iterator More...
 
difference_type operator- (const iter_impl &other) const
 return difference More...
 
iter_impl operator- (difference_type i) const
 subtract from iterator More...
 
iter_imploperator-- ()
 pre-decrement (–it) More...
 
const iter_impl operator-- (int)
 post-decrement (it–) More...
 
iter_imploperator-= (difference_type i)
 subtract from iterator More...
 
pointer operator-> () const
 dereference the iterator More...
 
bool operator< (const iter_impl &other) const
 comparison: smaller More...
 
bool operator<= (const iter_impl &other) const
 comparison: less than or equal More...
 
iter_imploperator= (const iter_impl< const BasicJsonType > &other) noexcept
 converting assignment More...
 
iter_imploperator= (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
 converting assignment More...
 
iter_imploperator= (iter_impl &&) noexcept=default
 
template<typename IterImpl , detail::enable_if_t<(std::is_same< IterImpl, iter_impl >::value||std::is_same< IterImpl, other_iter_impl >::value), std::nullptr_t > = nullptr>
bool operator== (const IterImpl &other) const
 comparison: equal More...
 
bool operator> (const iter_impl &other) const
 comparison: greater than More...
 
bool operator>= (const iter_impl &other) const
 comparison: greater than or equal More...
 
reference operator[] (difference_type n) const
 access to successor More...
 
void set_end () noexcept
 set the iterator past the last value More...
 
 switch (m_object->m_type)
 
reference value () const
 return the value of an iterator More...
 
 ~iter_impl ()=default
 

Data Fields

JSON_PRIVATE_UNLESS_TESTED __pad0__: void set_begin() noexcept { JSON_ASSERT(m_object != nullptr)
 
JSON_PRIVATE_UNLESS_TESTED __pad1__: pointer m_object = nullptr
 
internal_iterator< typename std::remove_const< BasicJsonType >::type > m_it {}
 the actual iterator of the associated instance More...
 

Private Types

using array_t = typename BasicJsonType::array_t
 
using object_t = typename BasicJsonType::object_t
 
using other_iter_impl = iter_impl< typename std::conditional< std::is_const< BasicJsonType >::value, typename std::remove_const< BasicJsonType >::type, const BasicJsonType >::type >
 the iterator with BasicJsonType of different const-ness More...
 

Private Attributes

friend BasicJsonType
 
friend iteration_proxy< iter_impl >
 
friend iteration_proxy_value< iter_impl >
 
friend other_iter_impl
 allow basic_json to access private members More...
 

Friends

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

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 11506 of file json.hpp.

Member Typedef Documentation

◆ array_t

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::array_t = typename BasicJsonType::array_t
private

Definition at line 11517 of file json.hpp.

◆ 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 11534 of file json.hpp.

◆ 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 11529 of file json.hpp.

◆ object_t

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::object_t = typename BasicJsonType::object_t
private

Definition at line 11516 of file json.hpp.

◆ other_iter_impl

template<typename BasicJsonType >
using nlohmann::detail::iter_impl< BasicJsonType >::other_iter_impl = iter_impl<typename std::conditional<std::is_const<BasicJsonType>::value, typename std::remove_const<BasicJsonType>::type, const BasicJsonType>::type>
private

the iterator with BasicJsonType of different const-ness

Definition at line 11509 of file json.hpp.

◆ 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 11538 of file json.hpp.

◆ 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 11543 of file json.hpp.

◆ 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 11532 of file json.hpp.

Constructor & Destructor Documentation

◆ iter_impl() [1/5]

template<typename BasicJsonType >
nlohmann::detail::iter_impl< BasicJsonType >::iter_impl ( )
default

◆ ~iter_impl()

template<typename BasicJsonType >
nlohmann::detail::iter_impl< BasicJsonType >::~iter_impl ( )
default

◆ iter_impl() [2/5]

template<typename BasicJsonType >
nlohmann::detail::iter_impl< BasicJsonType >::iter_impl ( iter_impl< BasicJsonType > &&  )
defaultnoexcept

◆ iter_impl() [3/5]

◆ iter_impl() [4/5]

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

const copy 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]otherconst iterator to copy from
Note
This copy constructor had to be defined explicitly to circumvent a bug occurring on msvc v19.0 compiler (VS 2015) debug build. For more information refer to: https://github.com/nlohmann/json/issues/1608

Definition at line 11606 of file json.hpp.

◆ iter_impl() [5/5]

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

converting constructor

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

Definition at line 11631 of file json.hpp.

Member Function Documentation

◆ key()

template<typename BasicJsonType >
const 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 12178 of file json.hpp.

References nlohmann::detail::invalid_iterator::create(), JSON_ASSERT, JSON_HEDLEY_LIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, and nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator.

+ Here is the call graph for this function:

◆ operator!=()

template<typename BasicJsonType >
template<typename IterImpl , detail::enable_if_t<(std::is_same< IterImpl, iter_impl >::value||std::is_same< IterImpl, other_iter_impl >::value), std::nullptr_t > = nullptr>
bool nlohmann::detail::iter_impl< BasicJsonType >::operator!= ( const IterImpl &  other) const
inline

comparison: not equal

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

Definition at line 11961 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::operator==().

+ Here is the call graph for this function:

◆ operator*()

◆ 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 12078 of file json.hpp.

References rotate-tower::result.

◆ operator++() [1/2]

◆ operator++() [2/2]

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

post-increment (it++)

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

Definition at line 11822 of file json.hpp.

References rotate-tower::result.

◆ operator+=()

◆ operator-() [1/2]

◆ 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 12100 of file json.hpp.

References rotate-tower::result.

◆ operator--() [1/2]

◆ operator--() [2/2]

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

post-decrement (it–)

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

Definition at line 11873 of file json.hpp.

References rotate-tower::result.

◆ 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 12069 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::operator+=().

+ Here is the call graph for this function:

◆ operator->()

◆ operator<()

◆ 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 12005 of file json.hpp.

Referenced by nlohmann::detail::iter_impl< BasicJsonType >::operator>().

+ Here is the caller graph for this function:

◆ operator=() [1/3]

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

converting assignment

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

Definition at line 11616 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::m_it.

◆ operator=() [2/3]

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]othernon-const iterator to copy from
Returns
const/non-const iterator
Note
It is not checked whether other is initialized.

Definition at line 11641 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::m_it.

◆ operator=() [3/3]

template<typename BasicJsonType >
iter_impl& nlohmann::detail::iter_impl< BasicJsonType >::operator= ( iter_impl< BasicJsonType > &&  )
defaultnoexcept

◆ operator==()

template<typename BasicJsonType >
template<typename IterImpl , detail::enable_if_t<(std::is_same< IterImpl, iter_impl >::value||std::is_same< IterImpl, other_iter_impl >::value), std::nullptr_t > = nullptr>
bool nlohmann::detail::iter_impl< BasicJsonType >::operator== ( const IterImpl &  other) const
inline

◆ 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 12014 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::operator<=().

+ Here is the call graph for this function:

◆ 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 12023 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::operator<().

+ Here is the call graph for this function:

◆ operator[]()

◆ set_end()

◆ switch()

◆ 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 12194 of file json.hpp.

References nlohmann::detail::iter_impl< BasicJsonType >::operator*().

+ Here is the call graph for this function:

Friends And Related Function 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 12089 of file json.hpp.

Field Documentation

◆ __pad0__

template<typename BasicJsonType >
JSON_PRIVATE_UNLESS_TESTED nlohmann::detail::iter_impl< BasicJsonType >::__pad0__

Definition at line 11655 of file json.hpp.

◆ __pad1__

template<typename BasicJsonType >
JSON_PRIVATE_UNLESS_TESTED nlohmann::detail::iter_impl< BasicJsonType >::__pad1__

Definition at line 12201 of file json.hpp.

◆ BasicJsonType

template<typename BasicJsonType >
friend nlohmann::detail::iter_impl< BasicJsonType >::BasicJsonType
private

Definition at line 11512 of file json.hpp.

◆ iteration_proxy< iter_impl >

template<typename BasicJsonType >
friend nlohmann::detail::iter_impl< BasicJsonType >::iteration_proxy< iter_impl >
private

Definition at line 11513 of file json.hpp.

◆ iteration_proxy_value< iter_impl >

template<typename BasicJsonType >
friend nlohmann::detail::iter_impl< BasicJsonType >::iteration_proxy_value< iter_impl >
private

Definition at line 11514 of file json.hpp.

◆ m_it

◆ other_iter_impl

template<typename BasicJsonType >
friend nlohmann::detail::iter_impl< BasicJsonType >::other_iter_impl
private

allow basic_json to access private members

Definition at line 11511 of file json.hpp.


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