\inmodule QtCore More...

#include <qjsonarray.h>

Collaboration diagram for QJsonArray::const_iterator:

Public Types
typedef std::random_access_iterator_tag	iterator_category
	A synonym for {std::random_access_iterator_tag} indicating this iterator is a random access iterator.

typedef qptrdiff	difference_type

typedef QJsonValue	value_type

typedef const QJsonValueRef	reference

typedef const QJsonValueRef *	pointer

Public Member Functions
	const_iterator ()
	Constructs an uninitialized iterator.

	const_iterator (const QJsonArray *array, qsizetype index)

	const_iterator (const iterator &o)
	Constructs a copy of other.

constexpr	const_iterator (const const_iterator &other)=default

const_iterator &	operator= (const const_iterator &other)

const QJsonValueConstRef	operator* () const
	Returns the current item.

const QJsonValueConstRef *	operator-> () const
	Returns a pointer to the current item.

QJsonValueConstRef	operator[] (qsizetype j) const
	Returns the item at offset j from the item pointed to by this iterator (the item at position {*this + j}).

const_iterator &	operator++ ()
	The prefix {++} operator, {++it}, advances the iterator to the next item in the array and returns an iterator to the new current item.

const_iterator	operator++ (int)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {++} operator, {it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item.

const_iterator &	operator-- ()
	The prefix {–} operator, {–it}, makes the preceding item current and returns an iterator to the new current item.

const_iterator	operator-- (int)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {–} operator, {it–}, makes the preceding item current and returns an iterator to the previously current item.

const_iterator &	operator+= (qsizetype j)
	Advances the iterator by j items.

const_iterator &	operator-= (qsizetype j)
	Makes the iterator go back by j items.

const_iterator	operator+ (qsizetype j) const
	Returns an iterator to the item at j positions forward from this iterator.

const_iterator	operator- (qsizetype j) const
	Returns an iterator to the item at j positions backward from this iterator.

qsizetype	operator- (const_iterator j) const
	Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

Friends
class	QJsonArray

bool	comparesEqual (const const_iterator &lhs, const const_iterator &rhs) noexcept

Qt::strong_ordering	compareThreeWay (const const_iterator &lhs, const const_iterator &rhs)

Detailed Description

\inmodule QtCore

The QJsonArray::const_iterator class provides an STL-style const iterator for QJsonArray.

\compares strong \compareswith strong QJsonArray::iterator \endcompareswith

QJsonArray::const_iterator allows you to iterate over a QJsonArray. If you want to modify the QJsonArray as you iterate over it, use QJsonArray::iterator instead. It is generally a good practice to use QJsonArray::const_iterator on a non-const QJsonArray as well, unless you need to change the QJsonArray through the iterator. Const iterators are slightly faster and improves code readability.

The default QJsonArray::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonArray function like QJsonArray::constBegin(), QJsonArray::constEnd(), or QJsonArray::insert() before you can start iterating.

Most QJsonArray functions accept an integer index rather than an iterator. For that reason, iterators are rarely useful in connection with QJsonArray. One place where STL-style iterators do make sense is as arguments to \l{generic algorithms}.

Multiple iterators can be used on the same array. However, be aware that any non-const function call performed on the QJsonArray will render all existing iterators undefined.

See also: QJsonArray::iterator

Definition at line 180 of file qjsonarray.h.

Member Typedef Documentation

◆ difference_type

typedef qptrdiff QJsonArray::const_iterator::difference_type

Definition at line 183 of file qjsonarray.h.

◆ iterator_category

typedef std::random_access_iterator_tag QJsonArray::const_iterator::iterator_category

A synonym for {std::random_access_iterator_tag} indicating this iterator is a random access iterator.

Definition at line 182 of file qjsonarray.h.

◆ pointer

typedef const QJsonValueRef* QJsonArray::const_iterator::pointer

Definition at line 186 of file qjsonarray.h.

◆ reference

typedef const QJsonValueRef QJsonArray::const_iterator::reference

Definition at line 185 of file qjsonarray.h.

◆ value_type

typedef QJsonValue QJsonArray::const_iterator::value_type

Definition at line 184 of file qjsonarray.h.

Constructor & Destructor Documentation

◆ const_iterator() [1/4]

QJsonArray::const_iterator::const_iterator ( )

inline

Constructs an uninitialized iterator.

Functions like operator*() and operator++() should not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See also: QJsonArray::constBegin(), QJsonArray::constEnd()

Definition at line 188 of file qjsonarray.h.

◆ const_iterator() [2/4]

QJsonArray::const_iterator::const_iterator	(	const QJsonArray *	array,
		qsizetype	index )

inlineexplicit

Definition at line 189 of file qjsonarray.h.

◆ const_iterator() [3/4]

QJsonArray::const_iterator::const_iterator ( const iterator & o )

inline

Constructs a copy of other.

Definition at line 191 of file qjsonarray.h.

◆ const_iterator() [4/4]

QJsonArray::const_iterator::const_iterator ( const const_iterator & other )

constexprdefault

Member Function Documentation

◆ operator*()

const QJsonValueConstRef QJsonArray::const_iterator::operator* ( ) const

inline

Returns the current item.

Definition at line 200 of file qjsonarray.h.

◆ operator+()

const_iterator QJsonArray::const_iterator::operator+ ( qsizetype j ) const

inline

Returns an iterator to the item at j positions forward from this iterator.

If j is negative, the iterator goes backward.

See also: operator-(), operator+=()

Definition at line 221 of file qjsonarray.h.

◆ operator++() [1/2]

const_iterator & QJsonArray::const_iterator::operator++ ( )

inline

The prefix {++} operator, {++it}, advances the iterator to the next item in the array and returns an iterator to the new current item.

Calling this function on QJsonArray::end() leads to undefined results.

See also: operator--()

Definition at line 215 of file qjsonarray.h.

◆ operator++() [2/2]

const_iterator QJsonArray::const_iterator::operator++ ( int )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {++} operator, {it++}, advances the iterator to the next item in the array and returns an iterator to the previously current item.

Definition at line 216 of file qjsonarray.h.

◆ operator+=()

const_iterator & QJsonArray::const_iterator::operator+= ( qsizetype j )

inline

Advances the iterator by j items.

If j is negative, the iterator goes backward.

See also: operator-=(), operator+()

Definition at line 219 of file qjsonarray.h.

◆ operator-() [1/2]

qsizetype QJsonArray::const_iterator::operator- ( const_iterator j ) const

inline

Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

Definition at line 223 of file qjsonarray.h.

◆ operator-() [2/2]

const_iterator QJsonArray::const_iterator::operator- ( qsizetype j ) const

inline

Returns an iterator to the item at j positions backward from this iterator.

If j is negative, the iterator goes forward.

See also: operator+(), operator-=()

Definition at line 222 of file qjsonarray.h.

◆ operator--() [1/2]

const_iterator & QJsonArray::const_iterator::operator-- ( )

inline

The prefix {–} operator, {–it}, makes the preceding item current and returns an iterator to the new current item.

Calling this function on QJsonArray::begin() leads to undefined results.

See also: operator++()

Definition at line 217 of file qjsonarray.h.

◆ operator--() [2/2]

const_iterator QJsonArray::const_iterator::operator-- ( int )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The postfix {–} operator, {it–}, makes the preceding item current and returns an iterator to the previously current item.

Definition at line 218 of file qjsonarray.h.

◆ operator-=()

const_iterator & QJsonArray::const_iterator::operator-= ( qsizetype j )

inline

Makes the iterator go back by j items.

If j is negative, the iterator goes forward.

See also: operator+=(), operator-()

Definition at line 220 of file qjsonarray.h.

◆ operator->()

const QJsonValueConstRef * QJsonArray::const_iterator::operator-> ( ) const

inline

Returns a pointer to the current item.

Definition at line 201 of file qjsonarray.h.

◆ operator=()

const_iterator & QJsonArray::const_iterator::operator= ( const const_iterator & other )

inline

Definition at line 194 of file qjsonarray.h.

◆ operator[]()

QJsonValueConstRef QJsonArray::const_iterator::operator[] ( qsizetype j ) const

inline

Returns the item at offset j from the item pointed to by this iterator (the item at position {*this + j}).

This function is provided to make QJsonArray iterators behave like C++ pointers.

See also: operator+()

Definition at line 203 of file qjsonarray.h.

Friends And Related Symbol Documentation

◆ comparesEqual

bool comparesEqual	(	const const_iterator &	lhs,
		const const_iterator &	rhs )

friend

Definition at line 240 of file qjsonarray.h.

◆ compareThreeWay

Qt::strong_ordering compareThreeWay	(	const const_iterator &	lhs,
		const const_iterator &	rhs )

friend

Definition at line 244 of file qjsonarray.h.

◆ QJsonArray

friend class QJsonArray

friend

Definition at line 251 of file qjsonarray.h.

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

qtbase/src/corelib/serialization/qjsonarray.h (029bb47e12d63e186663714c3776d3654285496b)
qtbase/src/corelib/serialization/qjsonarray.cpp (029bb47e12d63e186663714c3776d3654285496b)

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ const_iterator() [1/4]

◆ const_iterator() [2/4]

◆ const_iterator() [3/4]

◆ const_iterator() [4/4]

Member Function Documentation

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

Friends And Related Symbol Documentation

◆ comparesEqual

◆ compareThreeWay

◆ QJsonArray