\inmodule QtCore More...

#include <qcbormap.h>

Collaboration diagram for QCborMap::ConstIterator:

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 qsizetype	difference_type
typedef std::pair< QCborValueConstRef, QCborValueConstRef >	value_type
typedef std::pair< QCborValueConstRef, QCborValueConstRef >	reference
typedef std::pair< QCborValueConstRef, QCborValueConstRef >	pointer

Public Member Functions
constexpr	ConstIterator ()=default
	Constructs an uninitialized iterator.
constexpr	ConstIterator (const ConstIterator &)=default
	Constructs an iterator as a copy of other.
	~ConstIterator ()=default
ConstIterator &	operator= (const ConstIterator &other)
	Makes this iterator a copy of other and returns a reference to this iterator.
value_type	operator* () const
	Returns a pair containing the current item's key and value.
value_type	operator[] (qsizetype j) const
const QCborValueConstRef *	operator-> () const
	Returns a pointer to the current pair's value.
QCborValueConstRef	key () const
	Returns the current item's key.
QCborValueConstRef	keyRef () const
QCborValueConstRef	value () const
	Returns the current item's value.
ConstIterator &	operator++ ()
	The prefix {++} operator, {++i}, advances the iterator to the next item in the map and returns this iterator.
ConstIterator	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, {i++}, advances the iterator to the next item in the map and returns an iterator to the previously current item.
ConstIterator &	operator-- ()
	The prefix {–} operator, {–i}, makes the preceding item current and returns this iterator.
ConstIterator	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, {i–}, makes the preceding item current and returns an iterator pointing to the previously current item.
ConstIterator &	operator+= (qsizetype j)
	Advances the iterator by j items.
ConstIterator &	operator-= (qsizetype j)
	Makes the iterator go back by j items.
ConstIterator	operator+ (qsizetype j) const
	Returns an iterator to the item at j positions forward from this iterator.
ConstIterator	operator- (qsizetype j) const
	Returns an iterator to the item at j positions backward from this iterator.
qsizetype	operator- (ConstIterator j) const
	Returns the position of the item at iterator j relative to the item at this iterator.

Friends
class	Iterator
class	QCborMap
class	QCborValue
class	QCborValueRef
bool	comparesEqual (const ConstIterator &lhs, const ConstIterator &rhs) noexcept
Qt::strong_ordering	compareThreeWay (const ConstIterator &lhs, const ConstIterator &rhs)

Detailed Description

\inmodule QtCore

Since: 5.12

The QCborMap::ConstIterator class provides an STL-style const iterator for QCborMap.

\compares strong \compareswith strong Iterator \endcompareswith

QCborMap::ConstIterator allows you to iterate over a QCborMap. If you want to modify the QCborMap as you iterate over it, you must use QCborMap::Iterator instead. It is generally good practice to use QCborMap::ConstIterator, even on a non-const QCborMap, when you don't need to change the QCborMap through the iterator. Const iterators are slightly faster and improve code readability.

You must initialize the iterator using a QCborMap function like QCborMap::begin(), QCborMap::end(), or QCborMap::find() before you can start iterating..

Multiple iterators can be used on the same object. Existing iterators will however become dangling if the object gets modified.

See also: QCborMap::Iterator

Definition at line 152 of file qcbormap.h.

Member Typedef Documentation

◆ difference_type

typedef qsizetype QCborMap::ConstIterator::difference_type

Definition at line 162 of file qcbormap.h.

◆ iterator_category

typedef std::random_access_iterator_tag QCborMap::ConstIterator::iterator_category

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

Definition at line 161 of file qcbormap.h.

◆ pointer

typedef std::pair<QCborValueConstRef, QCborValueConstRef> QCborMap::ConstIterator::pointer

Definition at line 165 of file qcbormap.h.

◆ reference

typedef std::pair<QCborValueConstRef, QCborValueConstRef> QCborMap::ConstIterator::reference

Definition at line 164 of file qcbormap.h.

◆ value_type

typedef std::pair<QCborValueConstRef, QCborValueConstRef> QCborMap::ConstIterator::value_type

Definition at line 163 of file qcbormap.h.

Constructor & Destructor Documentation

◆ ConstIterator() [1/2]

QCborMap::ConstIterator::ConstIterator ( )

constexprdefault

Constructs an uninitialized iterator.

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

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

◆ ConstIterator() [2/2]

QCborMap::ConstIterator::ConstIterator ( const ConstIterator & other )

constexprdefault

Constructs an iterator as a copy of other.

◆ ~ConstIterator()

QCborMap::ConstIterator::~ConstIterator ( )

default

Member Function Documentation

◆ key()

QCborValueConstRef QCborMap::ConstIterator::key ( ) const

inline

Returns the current item's key.

See also: value()

Definition at line 186 of file qcbormap.h.

◆ keyRef()

QCborValueConstRef QCborMap::ConstIterator::keyRef ( ) const

inline

Definition at line 187 of file qcbormap.h.

◆ operator*()

value_type QCborMap::ConstIterator::operator* ( ) const

inline

Returns a pair containing the current item's key and value.

See also: key(), value()

Definition at line 178 of file qcbormap.h.

◆ operator+()

ConstIterator QCborMap::ConstIterator::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-()

Definition at line 210 of file qcbormap.h.

◆ operator++() [1/2]

ConstIterator & QCborMap::ConstIterator::operator++ ( )

inline

The prefix {++} operator, {++i}, advances the iterator to the next item in the map and returns this iterator.

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

See also: operator--()

Definition at line 204 of file qcbormap.h.

◆ operator++() [2/2]

ConstIterator QCborMap::ConstIterator::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, {i++}, advances the iterator to the next item in the map and returns an iterator to the previously current item.

Definition at line 205 of file qcbormap.h.

◆ operator+=()

ConstIterator & QCborMap::ConstIterator::operator+= ( qsizetype j )

inline

Advances the iterator by j items.

If j is negative, the iterator goes backward. Returns a reference to this iterator.

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

Definition at line 208 of file qcbormap.h.

◆ operator-() [1/2]

qsizetype QCborMap::ConstIterator::operator- ( QCborMap::ConstIterator j ) const

inline

Returns the position of the item at iterator j relative to the item at this iterator.

If the item at j is forward of this time, the returned value is negative.

See also: operator+()

Definition at line 212 of file qcbormap.h.

◆ operator-() [2/2]

ConstIterator QCborMap::ConstIterator::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+()

Definition at line 211 of file qcbormap.h.

◆ operator--() [1/2]

ConstIterator & QCborMap::ConstIterator::operator-- ( )

inline

The prefix {–} operator, {–i}, makes the preceding item current and returns this iterator.

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

See also: operator++()

Definition at line 206 of file qcbormap.h.

◆ operator--() [2/2]

ConstIterator QCborMap::ConstIterator::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, {i–}, makes the preceding item current and returns an iterator pointing to the previously current item.

Definition at line 207 of file qcbormap.h.

◆ operator-=()

ConstIterator & QCborMap::ConstIterator::operator-= ( qsizetype j )

inline

Makes the iterator go back by j items.

If j is negative, the iterator goes forward. Returns a reference to this iterator.

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

Definition at line 209 of file qcbormap.h.

◆ operator->()

const QCborValueConstRef * QCborMap::ConstIterator::operator-> ( ) const

inline

Returns a pointer to the current pair's value.

Definition at line 180 of file qcbormap.h.

◆ operator=()

ConstIterator & QCborMap::ConstIterator::operator= ( const ConstIterator & other )

inline

Makes this iterator a copy of other and returns a reference to this iterator.

Definition at line 170 of file qcbormap.h.

◆ operator[]()

value_type QCborMap::ConstIterator::operator[] ( qsizetype j ) const

inline

Definition at line 179 of file qcbormap.h.

◆ value()

QCborValueConstRef QCborMap::ConstIterator::value ( ) const

inline

Returns the current item's value.

See also: key(), operator*()

Definition at line 188 of file qcbormap.h.

◆ comparesEqual

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

friend

Definition at line 228 of file qcbormap.h.

◆ compareThreeWay

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

friend

Definition at line 232 of file qcbormap.h.

◆ Iterator

friend class Iterator

friend

Definition at line 154 of file qcbormap.h.

◆ QCborMap

friend class QCborMap

friend

Definition at line 155 of file qcbormap.h.

◆ QCborValue

friend class QCborValue

friend

Definition at line 156 of file qcbormap.h.

◆ QCborValueRef

friend class QCborValueRef

friend

Definition at line 157 of file qcbormap.h.

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

qtbase/src/corelib/serialization/qcbormap.h (762de4f590ad58581c2b40de289b309f95943964)
qtbase/src/corelib/serialization/qcbormap.cpp (bb30dc9f00598e1f2e079c847c9d784050fe0a66)

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ ConstIterator() [1/2]

◆ ConstIterator() [2/2]

◆ ~ConstIterator()

Member Function Documentation

◆ key()

◆ keyRef()

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

◆ value()

Friends And Related Symbol Documentation

◆ comparesEqual

◆ compareThreeWay

◆ Iterator

◆ QCborMap

◆ QCborValue

◆ QCborValueRef