Struct qt_core::q_map_of_q_string_q_variant::ConstIterator

#[repr(C)]
pub struct ConstIterator { /* fields omitted */ }

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

C++ class: QMap<QString, QVariant>::const_iterator.

C++ documentation:

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

QMap features both STL-style iterators and Java-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QMap<Key, T>::const_iterator allows you to iterate over a QMap (or a QMultiMap). If you want to modify the QMap as you iterate over it, you must use QMap::iterator instead. It is generally good practice to use QMap::const_iterator on a non-const QMap as well, unless you need to change the QMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMap function like QMap::constBegin(), QMap::constEnd(), or QMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMap<QString, int> map;
map.insert("January", 1);
map.insert("February", 2);
...
map.insert("December", 12);
QMap<QString, int>::const_iterator i;
for (i = map.constBegin(); i != map.constEnd(); ++i)
      cout << i.key() << ": " << i.value() << endl;

Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key (because they were inserted using QMap::insertMulti()) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

Methods

impl ConstIterator

pub unsafe fn copy_from(
    &mut self,
    other: impl CastInto<Ref<ConstIterator>>
) -> MutRef<ConstIterator>

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

Calls C++ function: QMap<QString, QVariant>::const_iterator& QMap<QString, QVariant>::const_iterator::operator=(const QMap<QString, QVariant>::const_iterator& other).

C++ documentation:

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

QMap features both STL-style iterators and Java-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QMap<Key, T>::const_iterator allows you to iterate over a QMap (or a QMultiMap). If you want to modify the QMap as you iterate over it, you must use QMap::iterator instead. It is generally good practice to use QMap::const_iterator on a non-const QMap as well, unless you need to change the QMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMap function like QMap::constBegin(), QMap::constEnd(), or QMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMap<QString, int> map;
map.insert("January", 1);
map.insert("February", 2);
...
map.insert("December", 12);
QMap<QString, int>::const_iterator i;
for (i = map.constBegin(); i != map.constEnd(); ++i)
      cout << i.key() << ": " << i.value() << endl;

Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key (because they were inserted using QMap::insertMulti()) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

pub unsafe fn dec_postfix(&mut self, arg1: c_int) -> CppBox<ConstIterator>

This is an overloaded function.

Calls C++ function: QMap<QString, QVariant>::const_iterator QMap<QString, QVariant>::const_iterator::operator--(int arg1).

C++ documentation:

This is an overloaded function.

The postfix -- operator (it--) makes the preceding item current and returns an iterator to the previously current item.

pub unsafe fn inc_postfix(&mut self, arg1: c_int) -> CppBox<ConstIterator>

This is an overloaded function.

Calls C++ function: QMap<QString, QVariant>::const_iterator QMap<QString, QVariant>::const_iterator::operator++(int arg1).

C++ documentation:

This is an overloaded function.

The postfix ++ operator (it++) advances the iterator to the next item in the container and returns an iterator to the previously current item.

pub unsafe fn key(&self) -> Ref<QString>

Returns the current key, converted to a QVariant.

Calls C++ function: const QString& QMap<QString, QVariant>::const_iterator::key() const.

C++ documentation:

Returns the current key, converted to a QVariant.

pub unsafe fn new_0a() -> CppBox<ConstIterator>

Constructs an uninitialized iterator.

Calls C++ function: [constructor] void QMap<QString, QVariant>::const_iterator::const_iterator().

C++ documentation:

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 QMap::constBegin() and QMap::constEnd().

pub unsafe fn new_1a(o: impl CastInto<Ref<Iterator>>) -> CppBox<ConstIterator>

Constructs a copy of other.

Calls C++ function: [constructor] void QMap<QString, QVariant>::const_iterator::const_iterator(const QMap<QString, QVariant>::iterator& o).

C++ documentation:

Constructs a copy of other.

pub unsafe fn new_copy(
    other: impl CastInto<Ref<ConstIterator>>
) -> CppBox<ConstIterator>

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

Calls C++ function: [constructor] void QMap<QString, QVariant>::const_iterator::const_iterator(const QMap<QString, QVariant>::const_iterator& other).

C++ documentation:

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

QMap features both STL-style iterators and Java-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QMap<Key, T>::const_iterator allows you to iterate over a QMap (or a QMultiMap). If you want to modify the QMap as you iterate over it, you must use QMap::iterator instead. It is generally good practice to use QMap::const_iterator on a non-const QMap as well, unless you need to change the QMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMap function like QMap::constBegin(), QMap::constEnd(), or QMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMap<QString, int> map;
map.insert("January", 1);
map.insert("February", 2);
...
map.insert("December", 12);
QMap<QString, int>::const_iterator i;
for (i = map.constBegin(); i != map.constEnd(); ++i)
      cout << i.key() << ": " << i.value() << endl;

Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key (because they were inserted using QMap::insertMulti()) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

pub unsafe fn struct_deref(&self) -> Ptr<QVariant>

Returns a pointer to the current result.

Calls C++ function: const QVariant* QMap<QString, QVariant>::const_iterator::operator->() const.

C++ documentation:

Returns a pointer to the current result.

pub unsafe fn value(&self) -> Ref<QVariant>

Returns the current value, converted to a QVariant.

Calls C++ function: const QVariant& QMap<QString, QVariant>::const_iterator::value() const.

C++ documentation:

Returns the current value, converted to a QVariant.

Trait Implementations

impl PartialEq<Ref<ConstIterator>> for ConstIterator

fn eq(&self, o: &Ref<ConstIterator>) -> bool

Returns true if other points to the same item as this iterator; otherwise returns false.

Calls C++ function: bool QMap<QString, QVariant>::const_iterator::operator==(const QMap<QString, QVariant>::const_iterator& o) const.

C++ documentation:

Returns true if other points to the same item as this iterator; otherwise returns false.

See also operator!=().

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> Add<i32> for &'_ ConstIterator

type Output = CppBox<ConstIterator>

The resulting type after applying the + operator.

fn add(self, j: c_int) -> CppBox<ConstIterator>

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

Calls C++ function: QMap<QString, QVariant>::const_iterator QMap<QString, QVariant>::const_iterator::operator+(int j) const.

C++ documentation:

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

See also operator-() and operator+=().

impl<'_> Sub<i32> for &'_ ConstIterator

type Output = CppBox<ConstIterator>

The resulting type after applying the - operator.

fn sub(self, j: c_int) -> CppBox<ConstIterator>

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

Calls C++ function: QMap<QString, QVariant>::const_iterator QMap<QString, QVariant>::const_iterator::operator-(int j) const.

C++ documentation:

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

See also operator+() and operator-=().

impl AddAssign<i32> for ConstIterator

fn add_assign(&mut self, j: c_int)

Advances the iterator by j items.

Calls C++ function: QMap<QString, QVariant>::const_iterator& QMap<QString, QVariant>::const_iterator::operator+=(int j).

C++ documentation:

Advances the iterator by j items.

See also operator-=() and operator+().

impl SubAssign<i32> for ConstIterator

fn sub_assign(&mut self, j: c_int)

Makes the iterator go back by j items.

Calls C++ function: QMap<QString, QVariant>::const_iterator& QMap<QString, QVariant>::const_iterator::operator-=(int j).

C++ documentation:

Makes the iterator go back by j items.

See also operator+=() and operator-().

impl CppDeletable for ConstIterator

unsafe fn delete(&mut self)

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

Calls C++ function: [destructor] void QMap<QString, QVariant>::const_iterator::~const_iterator().

C++ documentation:

The QMap::const_iterator class provides an STL-style const iterator for QMap and QMultiMap.

QMap features both STL-style iterators and Java-style iterators. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.

QMap<Key, T>::const_iterator allows you to iterate over a QMap (or a QMultiMap). If you want to modify the QMap as you iterate over it, you must use QMap::iterator instead. It is generally good practice to use QMap::const_iterator on a non-const QMap as well, unless you need to change the QMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMap function like QMap::constBegin(), QMap::constEnd(), or QMap::find() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMap<QString, int> map;
map.insert("January", 1);
map.insert("February", 2);
...
map.insert("December", 12);
QMap<QString, int>::const_iterator i;
for (i = map.constBegin(); i != map.constEnd(); ++i)
      cout << i.key() << ": " << i.value() << endl;

Unlike QHash, which stores its items in an arbitrary order, QMap stores its items ordered by key. Items that share the same key (because they were inserted using QMap::insertMulti()) will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

impl<'_> Decrement for &'_ mut ConstIterator

type Output = MutRef<ConstIterator>

Output type.

fn dec(self) -> MutRef<ConstIterator>

The prefix -- operator (--it) makes the preceding item current and returns an iterator to the new current item.

Calls C++ function: QMap<QString, QVariant>::const_iterator& QMap<QString, QVariant>::const_iterator::operator--().

C++ documentation:

The prefix -- operator (--it) makes the preceding item current and returns an iterator to the new current item.

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

See also operator++().

impl<'_> Indirection for &'_ ConstIterator

type Output = Ref<QVariant>

Output type.

fn indirection(self) -> Ref<QVariant>

Returns the current value, converted to a QVariant.

Calls C++ function: const QVariant& QMap<QString, QVariant>::const_iterator::operator*() const.

C++ documentation:

Returns the current value, converted to a QVariant.

impl<'_> Increment for &'_ mut ConstIterator

type Output = MutRef<ConstIterator>

Output type.

fn inc(self) -> MutRef<ConstIterator>

The prefix ++ operator (++it) advances the iterator to the next item in the container and returns an iterator to the new current item.

Calls C++ function: QMap<QString, QVariant>::const_iterator& QMap<QString, QVariant>::const_iterator::operator++().

C++ documentation:

The prefix ++ operator (++it) advances the iterator to the next item in the container and returns an iterator to the new current item.

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

See also operator--().