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 <XrdOucJson.hh>
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 | |
| ~iter_impl ()=default | |
| iter_impl (iter_impl &&) noexcept=default | |
| iter_impl & | operator= (iter_impl &&) noexcept=default |
| iter_impl (pointer object) noexcept | |
| constructor for a given JSON instance | |
| iter_impl (const iter_impl< const BasicJsonType > &other) noexcept | |
| const copy constructor | |
| iter_impl & | operator= (const iter_impl< const BasicJsonType > &other) noexcept |
| converting assignment | |
| iter_impl (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept | |
| converting constructor | |
| iter_impl & | operator= (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept |
| converting assignment | |
| switch (m_object->m_type) | |
| void | set_end () noexcept |
| set the iterator past the last value | |
| 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_impl & | operator++ () |
| pre-increment (++it) | |
| iter_impl const | operator-- (int) |
| post-decrement (it–) | |
| iter_impl & | operator-- () |
| pre-decrement (–it) | |
| 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 | |
| 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 | |
| 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_impl & | operator+= (difference_type i) |
| add to iterator | |
| iter_impl & | operator-= (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 | |
| const object_t::key_type & | key () const |
| return the key of an object iterator | |
| reference | value () const |
| return the value of an iterator | |
Public Attributes | |
| JSON_PRIVATE_UNLESS_TESTED | : void set_begin() noexcept { JSON_ASSERT(m_object != nullptr) |
| JSON_PRIVATE_UNLESS_TESTED | : pointer m_object = nullptr |
| internal_iterator< typename std::remove_const< BasicJsonType >::type > | m_it {} |
| the actual iterator of the associated instance | |
Private Types | |
| 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 | |
| using | object_t = typename BasicJsonType::object_t |
| using | array_t = typename BasicJsonType::array_t |
Private Attributes | |
| friend | other_iter_impl |
| allow basic_json to access private members | |
| friend | BasicJsonType |
| friend | iteration_proxy< iter_impl > |
| friend | iteration_proxy_value< iter_impl > |
Friends | |
| iter_impl | operator+ (difference_type i, const iter_impl &it) |
| addition of distance and iterator | |
Detailed Description
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)
Member Typedef Documentation
◆ array_t
|
private |
◆ difference_type
| using nlohmann::detail::iter_impl< BasicJsonType >::difference_type = typename BasicJsonType::difference_type |
a type to represent differences between iterators
◆ iterator_category
| 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.
◆ object_t
|
private |
◆ other_iter_impl
|
private |
the iterator with BasicJsonType of different const-ness
◆ pointer
| 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)
◆ reference
| 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)
◆ value_type
| using nlohmann::detail::iter_impl< BasicJsonType >::value_type = typename BasicJsonType::value_type |
the type of the values when the iterator is dereferenced
Constructor & Destructor Documentation
◆ iter_impl() [1/5]
|
default |
◆ ~iter_impl()
|
default |
◆ iter_impl() [2/5]
|
defaultnoexcept |
◆ iter_impl() [3/5]
|
inlineexplicitnoexcept |
constructor for a given JSON instance
- Parameters
-
[in] object pointer to a JSON object for this iterator
- Precondition
- object != nullptr
- Postcondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, JSON_ASSERT, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ iter_impl() [4/5]
|
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] other const 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
◆ iter_impl() [5/5]
|
inlinenoexcept |
converting constructor
- Parameters
-
[in] other non-const iterator to copy from
- Note
- It is not checked whether other is initialized.
Member Function Documentation
◆ key()
|
inline |
return the key of an object iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
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.
◆ operator!=()
|
inline |
comparison: not equal
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::iter_impl< BasicJsonType >::operator==().
◆ operator*()
|
inline |
return a reference to the value pointed to by the iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, nlohmann::detail::primitive_iterator_t::is_begin(), JSON_ASSERT, JSON_HEDLEY_LIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
Referenced by nlohmann::detail::iter_impl< BasicJsonType >::value().
◆ operator+()
|
inline |
add to iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
◆ operator++() [1/2]
|
inline |
pre-increment (++it)
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, JSON_ASSERT, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ operator++() [2/2]
|
inline |
post-increment (it++)
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
◆ operator+=()
|
inline |
add to iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, JSON_ASSERT, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
Referenced by nlohmann::detail::iter_impl< BasicJsonType >::operator-=().
◆ operator-() [1/2]
|
inline |
return difference
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, JSON_ASSERT, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ operator-() [2/2]
|
inline |
subtract from iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
◆ operator--() [1/2]
|
inline |
pre-decrement (–it)
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, JSON_ASSERT, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ operator--() [2/2]
|
inline |
post-decrement (it–)
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
◆ operator-=()
|
inline |
subtract from iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::iter_impl< BasicJsonType >::operator+=().
◆ operator->()
|
inline |
dereference the iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, nlohmann::detail::primitive_iterator_t::is_begin(), JSON_ASSERT, JSON_HEDLEY_LIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ operator<()
|
inline |
comparison: smaller
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, JSON_ASSERT, JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
Referenced by nlohmann::detail::iter_impl< BasicJsonType >::operator>=().
◆ operator<=()
|
inline |
comparison: less than or equal
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
Referenced by nlohmann::detail::iter_impl< BasicJsonType >::operator>().
◆ operator=() [1/3]
|
inlinenoexcept |
converting assignment
- Parameters
-
[in] other const iterator to copy from
- Returns
- const/non-const iterator
- Note
- It is not checked whether other is initialized.
References nlohmann::detail::iter_impl< BasicJsonType >::m_it.
◆ operator=() [2/3]
|
inlinenoexcept |
converting assignment
- Parameters
-
[in] other non-const iterator to copy from
- Returns
- const/non-const iterator
- Note
- It is not checked whether other is initialized.
References nlohmann::detail::iter_impl< BasicJsonType >::m_it.
◆ operator=() [3/3]
|
defaultnoexcept |
◆ operator==()
|
inline |
comparison: equal
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, JSON_ASSERT, JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
Referenced by nlohmann::detail::iter_impl< BasicJsonType >::operator!=().
◆ operator>()
|
inline |
comparison: greater than
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::iter_impl< BasicJsonType >::operator<=().
◆ operator>=()
|
inline |
comparison: greater than or equal
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::iter_impl< BasicJsonType >::operator<().
◆ operator[]()
|
inline |
access to successor
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::invalid_iterator::create(), nlohmann::detail::discarded, nlohmann::detail::primitive_iterator_t::get_value(), JSON_ASSERT, JSON_HEDLEY_LIKELY, JSON_THROW, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, and nlohmann::detail::string.
◆ set_end()
|
inlinenoexcept |
set the iterator past the last value
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, JSON_ASSERT, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, nlohmann::detail::primitive_iterator_t::set_end(), and nlohmann::detail::string.
Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::cend(), and nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::end().
◆ switch()
|
inline |
References nlohmann::detail::array, nlohmann::detail::internal_iterator< BasicJsonType >::array_iterator, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, nlohmann::detail::iter_impl< BasicJsonType >::m_it, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, nlohmann::detail::internal_iterator< BasicJsonType >::object_iterator, nlohmann::detail::internal_iterator< BasicJsonType >::primitive_iterator, nlohmann::detail::primitive_iterator_t::set_begin(), nlohmann::detail::primitive_iterator_t::set_end(), and nlohmann::detail::string.
◆ value()
|
inline |
return the value of an iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
References nlohmann::detail::iter_impl< BasicJsonType >::operator*().
Friends And Related Symbol Documentation
◆ operator+
|
friend |
addition of distance and iterator
- Precondition
- The iterator is initialized; i.e.
m_object != nullptr.
Member Data Documentation
◆ __pad0__
| JSON_PRIVATE_UNLESS_TESTED nlohmann::detail::iter_impl< BasicJsonType >::__pad0__ |
◆ __pad1__
| JSON_PRIVATE_UNLESS_TESTED nlohmann::detail::iter_impl< BasicJsonType >::__pad1__ |
◆ BasicJsonType
|
private |
◆ iteration_proxy< iter_impl >
|
private |
◆ iteration_proxy_value< iter_impl >
|
private |
◆ m_it
| internal_iterator<typename std::remove_const<BasicJsonType>::type> nlohmann::detail::iter_impl< BasicJsonType >::m_it {} |
the actual iterator of the associated instance
Referenced by nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::insert(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::insert(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::insert_iterator(), nlohmann::detail::iter_impl< BasicJsonType >::iter_impl(), nlohmann::detail::iter_impl< BasicJsonType >::key(), nlohmann::detail::iter_impl< BasicJsonType >::operator*(), nlohmann::detail::iter_impl< BasicJsonType >::operator++(), nlohmann::detail::iter_impl< BasicJsonType >::operator+=(), nlohmann::detail::iter_impl< BasicJsonType >::operator-(), nlohmann::detail::iter_impl< BasicJsonType >::operator--(), nlohmann::detail::iter_impl< BasicJsonType >::operator->(), nlohmann::detail::iter_impl< BasicJsonType >::operator<(), nlohmann::detail::iter_impl< BasicJsonType >::operator=(), nlohmann::detail::iter_impl< BasicJsonType >::operator=(), nlohmann::detail::iter_impl< BasicJsonType >::operator==(), nlohmann::detail::iter_impl< BasicJsonType >::operator[](), nlohmann::detail::iter_impl< BasicJsonType >::set_end(), and nlohmann::detail::iter_impl< BasicJsonType >::switch().
◆ other_iter_impl
|
private |
allow basic_json to access private members
The documentation for this class was generated from the following file:
