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

Collaboration diagram for nlohmann::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
	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.

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 (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_impl &	operator++ ()
	pre-increment (++it) More...

iter_impl const	operator++ (int)
	post-increment (it++) More...

iter_impl &	operator+= (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_impl &	operator-- ()
	pre-decrement (–it) More...

iter_impl const	operator-- (int)
	post-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< const BasicJsonType > &other) noexcept
	converting assignment More...

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

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

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)

Constructor & Destructor Documentation

◆ iter_impl() [1/3]

template<typename BasicJsonType >

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

explicitnoexcept

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::binary_reader< BasicJsonType, InputAdapterType, SAX >::chars_read, nlohmann::detail::parse_error::create(), and nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::sax.

◆ iter_impl() [2/3]

template<typename BasicJsonType >

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

noexcept

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() [3/3]

template<typename BasicJsonType >

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

noexcept

converting constructor

Parameters

[in] other non-const iterator to copy from

Note: It is not checked whether other is initialized.

Member Function Documentation

◆ key()

template<typename BasicJsonType >

const object_t::key_type & nlohmann::detail::iter_impl< BasicJsonType >::key ( ) const

return the key of an object iterator

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

◆ 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

comparison: not equal

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

References nlohmann::detail::key, and nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::sax.

◆ operator*()

template<typename BasicJsonType >

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

return a reference to the value pointed to by the iterator

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

◆ operator+()

template<typename BasicJsonType >

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

add to iterator

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

◆ operator++() [1/2]

template<typename BasicJsonType >

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

pre-increment (++it)

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

◆ operator++() [2/2]

template<typename BasicJsonType >

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

post-increment (it++)

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

◆ operator+=()

template<typename BasicJsonType >

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

add to iterator

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

◆ operator-() [1/2]

template<typename BasicJsonType >

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

return difference

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

◆ operator-() [2/2]

template<typename BasicJsonType >

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

subtract from iterator

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

◆ operator--() [1/2]

template<typename BasicJsonType >

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

pre-decrement (–it)

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

◆ operator--() [2/2]

template<typename BasicJsonType >

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

post-decrement (it–)

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

◆ operator-=()

template<typename BasicJsonType >

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

subtract from iterator

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

◆ operator->()

template<typename BasicJsonType >

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

dereference the iterator

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

◆ operator<()

template<typename BasicJsonType >

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

comparison: smaller

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

References nlohmann::detail::key, and nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::sax.

◆ operator<=()

template<typename BasicJsonType >

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

comparison: less than or equal

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

◆ operator=() [1/2]

template<typename BasicJsonType >

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

noexcept

converting assignment

Parameters

[in] other const iterator to copy from

Returns: const/non-const iterator

Note: It is not checked whether other is initialized.

◆ operator=() [2/2]

template<typename BasicJsonType >

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

noexcept

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.

◆ 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

comparison: equal

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

◆ operator>()

template<typename BasicJsonType >

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

comparison: greater than

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

◆ operator>=()

template<typename BasicJsonType >

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

comparison: greater than or equal

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

◆ operator[]()

template<typename BasicJsonType >

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

access to successor

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

◆ value()

template<typename BasicJsonType >

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

return the value of an iterator

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

References nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::sax.

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.

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ iter_impl() [1/3]

◆ iter_impl() [2/3]

◆ iter_impl() [3/3]

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/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ value()

Friends And Related Function Documentation

◆ operator+