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::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >:

Public Types
using	difference_type = typename BasicJsonType::difference_type
	a type to represent differences between iterators

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)

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)

using	value_type = typename BasicJsonType::value_type
	the type of the values when the iterator is dereferenced

Public Member Functions
	iter_impl ()=default

	iter_impl (const iter_impl< const BasicJsonType > &other) noexcept
	const copy constructor

	iter_impl (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
	converting constructor

	iter_impl (iter_impl &&) noexcept=default

	iter_impl (pointer object) noexcept
	constructor for a given JSON instance

const object_t::key_type &	key () const
	return the key of an object iterator

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

reference	operator* () const
	return a reference to the value pointed to by the iterator

iter_impl	operator+ (difference_type i) const
	add to iterator

iter_impl &	operator++ ()
	pre-increment (++it)

iter_impl	operator++ (int) &
	post-increment (it++)

iter_impl &	operator+= (difference_type i)
	add to iterator

difference_type	operator- (const iter_impl &other) const
	return difference

iter_impl	operator- (difference_type i) const
	subtract from iterator

iter_impl &	operator-- ()
	pre-decrement (–it)

iter_impl	operator-- (int) &
	post-decrement (it–)

iter_impl &	operator-= (difference_type i)
	subtract from iterator

pointer	operator-> () const
	dereference the iterator

bool	operator< (const iter_impl &other) const
	comparison: smaller

bool	operator<= (const iter_impl &other) const
	comparison: less than or equal

iter_impl &	operator= (const iter_impl< const BasicJsonType > &other) noexcept
	converting assignment

iter_impl &	operator= (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
	converting assignment

iter_impl &	operator= (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

bool	operator> (const iter_impl &other) const
	comparison: greater than

bool	operator>= (const iter_impl &other) const
	comparison: greater than or equal

reference	operator[] (difference_type n) const
	access to successor

reference	value () const
	return the value of an iterator

	~iter_impl ()=default

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

Private Member Functions
void	set_begin () noexcept
	set the iterator to the first value

void	set_end () noexcept
	set the iterator past the last value

Private Attributes
friend	BasicJsonType

friend	iteration_proxy< iter_impl >

friend	iteration_proxy_value< iter_impl >

internal_iterator< typename std::remove_const< BasicJsonType >::type >	m_it {}
	the actual iterator of the associated instance

pointer	m_object = nullptr
	associated JSON instance

friend	other_iter_impl
	allow basic_json to access private members

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

Detailed Description

template<typename BasicJsonType>
class nlohmann::json_abi_v3_11_3::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 12915 of file json.hpp.

Member Typedef Documentation

◆ array_t

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::array_t = typename BasicJsonType::array_t

private

Definition at line 12926 of file json.hpp.

◆ difference_type

template<typename BasicJsonType >

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

a type to represent differences between iterators

Definition at line 12946 of file json.hpp.

◆ iterator_category

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::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 12941 of file json.hpp.

◆ object_t

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::object_t = typename BasicJsonType::object_t

private

Definition at line 12925 of file json.hpp.

◆ other_iter_impl

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::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 12918 of file json.hpp.

◆ pointer

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::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 12948 of file json.hpp.

◆ reference

template<typename BasicJsonType >

using nlohmann::json_abi_v3_11_3::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 12952 of file json.hpp.

◆ value_type

template<typename BasicJsonType >

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

the type of the values when the iterator is dereferenced

Definition at line 12944 of file json.hpp.

Constructor & Destructor Documentation

◆ iter_impl() [1/5]

template<typename BasicJsonType >

nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::iter_impl ( )

default

◆ ~iter_impl()

template<typename BasicJsonType >

nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::~iter_impl ( )

default

◆ iter_impl() [2/5]

template<typename BasicJsonType >

nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::iter_impl ( iter_impl< BasicJsonType > && )

defaultnoexcept

◆ iter_impl() [3/5]

template<typename BasicJsonType >

nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::iter_impl ( pointer object )

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.

Definition at line 12968 of file json.hpp.

References JSON_ASSERT.

◆ iter_impl() [4/5]

template<typename BasicJsonType >

nlohmann::json_abi_v3_11_3::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] 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

Definition at line 13018 of file json.hpp.

◆ iter_impl() [5/5]

template<typename BasicJsonType >

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

inlinenoexcept

converting constructor

Parameters

[in] other non-const iterator to copy from

Note: It is not checked whether other is initialized.

Definition at line 13043 of file json.hpp.

Member Function Documentation

◆ key()

template<typename BasicJsonType >

const object_t::key_type & nlohmann::json_abi_v3_11_3::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 13590 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_LIKELY, and JSON_THROW.

◆ 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::json_abi_v3_11_3::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 13373 of file json.hpp.

◆ operator*()

template<typename BasicJsonType >

reference nlohmann::json_abi_v3_11_3::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 13148 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_LIKELY, and JSON_THROW.

◆ operator+()

template<typename BasicJsonType >

iter_impl nlohmann::json_abi_v3_11_3::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 13490 of file json.hpp.

◆ operator++() [1/2]

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator++ ( )

inline

pre-increment (++it)

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

Definition at line 13245 of file json.hpp.

References JSON_ASSERT.

◆ operator++() [2/2]

template<typename BasicJsonType >

iter_impl nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator++ ( int ) &

inline

post-increment (it++)

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

Definition at line 13234 of file json.hpp.

◆ operator+=()

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::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 13444 of file json.hpp.

References JSON_ASSERT, and JSON_THROW.

◆ operator-() [1/2]

template<typename BasicJsonType >

difference_type nlohmann::json_abi_v3_11_3::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 13523 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::internal_iterator< BasicJsonType >::array_iterator, JSON_ASSERT, JSON_THROW, nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_it, and nlohmann::json_abi_v3_11_3::detail::internal_iterator< BasicJsonType >::primitive_iterator.

◆ operator-() [2/2]

template<typename BasicJsonType >

iter_impl nlohmann::json_abi_v3_11_3::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 13512 of file json.hpp.

◆ operator--() [1/2]

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator-- ( )

inline

pre-decrement (–it)

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

Definition at line 13296 of file json.hpp.

References JSON_ASSERT.

◆ operator--() [2/2]

template<typename BasicJsonType >

iter_impl nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator-- ( int ) &

inline

post-decrement (it–)

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

Definition at line 13285 of file json.hpp.

◆ operator-=()

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::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 13481 of file json.hpp.

◆ operator->()

template<typename BasicJsonType >

pointer nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator-> ( ) const

inline

dereference the iterator

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

Definition at line 13192 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_LIKELY, and JSON_THROW.

◆ operator<()

template<typename BasicJsonType >

bool nlohmann::json_abi_v3_11_3::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 13382 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::internal_iterator< BasicJsonType >::array_iterator, JSON_ASSERT, JSON_HEDLEY_UNLIKELY, JSON_THROW, nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_it, nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_object, and nlohmann::json_abi_v3_11_3::detail::internal_iterator< BasicJsonType >::primitive_iterator.

◆ operator<=()

template<typename BasicJsonType >

bool nlohmann::json_abi_v3_11_3::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 13417 of file json.hpp.

◆ operator=() [1/3]

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator= ( const iter_impl< const BasicJsonType > & other )

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.

Definition at line 13028 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_object.

◆ operator=() [2/3]

template<typename BasicJsonType >

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

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.

Definition at line 13053 of file json.hpp.

References nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_object.

◆ operator=() [3/3]

template<typename BasicJsonType >

iter_impl & nlohmann::json_abi_v3_11_3::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::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator== ( const IterImpl & other ) const

inline

comparison: equal

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

Definition at line 13337 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_UNLIKELY, and JSON_THROW.

◆ operator>()

template<typename BasicJsonType >

bool nlohmann::json_abi_v3_11_3::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 13426 of file json.hpp.

◆ operator>=()

template<typename BasicJsonType >

bool nlohmann::json_abi_v3_11_3::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 13435 of file json.hpp.

◆ operator[]()

template<typename BasicJsonType >

reference nlohmann::json_abi_v3_11_3::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 13552 of file json.hpp.

References JSON_ASSERT, JSON_HEDLEY_LIKELY, and JSON_THROW.

◆ set_begin()

template<typename BasicJsonType >

void nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::set_begin ( )

inlineprivatenoexcept

set the iterator to the first value

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

Definition at line 13065 of file json.hpp.

References JSON_ASSERT.

◆ set_end()

template<typename BasicJsonType >

void nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::set_end ( )

inlineprivatenoexcept

set the iterator past the last value

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

Definition at line 13109 of file json.hpp.

References JSON_ASSERT.

◆ value()

template<typename BasicJsonType >

reference nlohmann::json_abi_v3_11_3::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 13606 of file json.hpp.

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

Member Data Documentation

◆ BasicJsonType

template<typename BasicJsonType >

friend nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::BasicJsonType

private

Definition at line 12921 of file json.hpp.

◆ iteration_proxy< iter_impl >

template<typename BasicJsonType >

friend nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::iteration_proxy< iter_impl >

private

Definition at line 12922 of file json.hpp.

◆ iteration_proxy_value< iter_impl >

template<typename BasicJsonType >

friend nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::iteration_proxy_value< iter_impl >

private

Definition at line 12923 of file json.hpp.

◆ m_it

template<typename BasicJsonType >

internal_iterator<typename std::remove_const<BasicJsonType>::type> nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_it {}

private

the actual iterator of the associated instance

Definition at line 13615 of file json.hpp.

Referenced by nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator-(), and nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator<().

◆ m_object

template<typename BasicJsonType >

pointer nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::m_object = nullptr

private

associated JSON instance

Definition at line 13613 of file json.hpp.

Referenced by nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator<(), nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator=(), and nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::operator=().

◆ other_iter_impl

template<typename BasicJsonType >

friend nlohmann::json_abi_v3_11_3::detail::iter_impl< BasicJsonType >::other_iter_impl

private

allow basic_json to access private members

Definition at line 12920 of file json.hpp.

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

json.hpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ array_t

◆ difference_type

◆ iterator_category

◆ object_t

◆ other_iter_impl

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ iter_impl() [1/5]

◆ ~iter_impl()

◆ iter_impl() [2/5]

◆ iter_impl() [3/5]

◆ iter_impl() [4/5]

◆ iter_impl() [5/5]

Member Function Documentation

◆ key()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator->()

◆ operator<()

◆ operator<=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ set_begin()

◆ set_end()

◆ value()

Friends And Related Symbol Documentation

◆ operator+

Member Data Documentation

◆ BasicJsonType

◆ iteration_proxy< iter_impl >

◆ iteration_proxy_value< iter_impl >

◆ m_it

◆ m_object

◆ other_iter_impl