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

#include <json.hpp>

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

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

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

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

bool	operator!= (const iter_impl &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_impl const	operator++ (int)
	post-increment (it++) More...

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

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

iter_impl	operator- (difference_type i) const
	subtract from iterator More...

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

iter_impl const	operator-- (int)
	post-decrement (it–) More...

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

iter_impl &	operator-= (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_impl &	operator= (const iter_impl< typename std::remove_const< BasicJsonType >::type > &other) noexcept
	converting assignment More...

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

reference	value () const
	return the value of an iterator More...

Private Types
using	array_t = typename BasicJsonType::array_t

using	object_t = typename BasicJsonType::object_t

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

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

Private Attributes
friend	BasicJsonType

friend	iteration_proxy< iter_impl >

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

pointer	m_object = nullptr
	associated JSON instance 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.**

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

Member Typedef Documentation

template<typename BasicJsonType>

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

private

Definition at line 3923 of file json.hpp.

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

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

template<typename BasicJsonType>

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

private

Definition at line 3922 of file json.hpp.

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

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

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

Constructor & Destructor Documentation

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

template<typename BasicJsonType>

nlohmann::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 3960 of file json.hpp.

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] other non-const iterator to copy from

Note: It is not checked whether other is initialized.

Definition at line 4000 of file json.hpp.

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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] other non-const iterator to copy from

Returns: const/non-const iterator

Note: It is not checked whether other is initialized.

Definition at line 4009 of file json.hpp.

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

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

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

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

template<typename BasicJsonType>

void nlohmann::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 4021 of file json.hpp.

template<typename BasicJsonType>

void nlohmann::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 4058 of file json.hpp.

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

Friends And Related Function Documentation

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

Member Data Documentation

template<typename BasicJsonType>

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

private

Definition at line 3919 of file json.hpp.

template<typename BasicJsonType>

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

private

Definition at line 3920 of file json.hpp.

template<typename BasicJsonType>

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

private

the actual iterator of the associated instance

Definition at line 4484 of file json.hpp.

template<typename BasicJsonType>

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

private

associated JSON instance

Definition at line 4482 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

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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