Struct qt_core::q_cbor_map::Iterator

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

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

C++ class: QCborMap::Iterator.

C++ documentation:

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

QCborMap::Iterator allows you to iterate over a QCborMap and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QCborMap, you should use QCborMap::ConstIterator. It is generally good practice to use QCborMap::ConstIterator on a non-const QCborMap as well, unless you 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 once the object gets modified.

Methods

impl Iterator

pub unsafe fn add_assign(&self, j: c_longlong) -> Ref<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator+=(long long j).

C++ documentation:

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

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

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

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator=(const QCborMap::Iterator& other).

C++ documentation:

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

pub unsafe fn dec(&self) -> Ref<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

The prefix -- operator, --it, makes the preceding item current and returns this iterator.

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator--().

C++ documentation:

The prefix -- operator, --it, makes the preceding item current and returns this iterator.

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

See also operator++().

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

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QCborMap::Iterator QCborMap::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(&self) -> Ref<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

The prefix ++ operator, ++it, advances the iterator to the next item in the array and returns this iterator.

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator++().

C++ documentation:

The prefix ++ operator, ++it, advances the iterator to the next item in the array and returns this iterator.

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

See also operator--().

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

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

This is an overloaded function.

Calls C++ function: QCborMap::Iterator QCborMap::Iterator::operator++(int arg1).

C++ documentation:

This is an overloaded function.

The postfix ++ operator, it++, advances the iterator to the next item in the array and returns an iterator to the previously current item.

pub unsafe fn indirection(&self) -> CppBox<QPairOfQCborValueRefQCborValueRef>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns a modifiable reference to the current item.

Calls C++ function: QPair<QCborValueRef, QCborValueRef> QCborMap::Iterator::operator*() const.

C++ documentation:

Returns a modifiable reference to the current item.

You can change the value of an item by using operator*() on the left side of an assignment.

The return value is of type QCborValueRef, a helper class for QCborArray and QCborMap. When you get an object of type QCborValueRef, you can use it as if it were a reference to a QCborValue. If you assign to it, the assignment will apply to the element in the QCborArray or QCborMap from which you got the reference.

pub unsafe fn key(&self) -> CppBox<QCborValue>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns the current item's key.

Calls C++ function: QCborValue QCborMap::Iterator::key() const.

C++ documentation:

Returns the current item's key.

There is no direct way of changing an item's key through an iterator, although it can be done by calling QCborMap::erase() followed by QCborMap::insert().

See also value().

pub unsafe fn new() -> CppBox<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Constructs an uninitialized iterator.

Calls C++ function: [constructor] void QCborMap::Iterator::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 QCborMap::begin() and QCborMap::end().

pub unsafe fn new_copy(arg1: impl CastInto<Ref<Iterator>>) -> CppBox<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Constructs an iterator as a copy of other.

Calls C++ function: [constructor] void QCborMap::Iterator::Iterator(const QCborMap::Iterator& arg1).

C++ documentation:

Constructs an iterator as a copy of other.

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

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns a pointer to a modifiable reference to the current item.

Calls C++ function: QCborValueRef* QCborMap::Iterator::operator->() const.

C++ documentation:

Returns a pointer to a modifiable reference to the current item.

pub unsafe fn sub_assign(&self, j: c_longlong) -> Ref<Iterator>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Makes the iterator go back by j positions. If j is negative, the iterator goes forward. Returns a reference to this iterator.

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator-=(long long j).

C++ documentation:

Makes the iterator go back by j positions. If j is negative, the iterator goes forward. Returns a reference to this iterator.

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

pub unsafe fn value(&self) -> CppBox<QCborValueRef>

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Returns a modifiable reference to the current item's value.

Calls C++ function: QCborValueRef QCborMap::Iterator::value() const.

C++ documentation:

Returns a modifiable reference to the current item's value.

You can change the value for a key by using value() on the left side of an assignment.

The return value is of type QCborValueRef, a helper class for QCborArray and QCborMap. When you get an object of type QCborValueRef, you can use it as if it were a reference to a QCborValue. If you assign to it, the assignment will apply to the element in the QCborArray or QCborMap from which you got the reference.

See also key() and operator*().

Trait Implementations

impl<'_> Add<i64> for &'_ Iterator

type Output = CppBox<Iterator>

The resulting type after applying the + operator.

fn add(self, j: c_longlong) -> CppBox<Iterator>

Returns an iterator to the item at position j steps forward from this iterator. If j is negative, the iterator goes backward.

Calls C++ function: QCborMap::Iterator QCborMap::Iterator::operator+(long long j) const.

C++ documentation:

Returns an iterator to the item at position j steps forward from this iterator. If j is negative, the iterator goes backward.

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

impl CppDeletable for Iterator

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QCborMap::Iterator::~Iterator().

C++ documentation:

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

QCborMap::Iterator allows you to iterate over a QCborMap and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QCborMap, you should use QCborMap::ConstIterator. It is generally good practice to use QCborMap::ConstIterator on a non-const QCborMap as well, unless you 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 once the object gets modified.

impl Decrement for Iterator

type Output = Ref<Iterator>

Output type.

unsafe fn dec(&self) -> Ref<Iterator>

The prefix -- operator, --it, makes the preceding item current and returns this iterator.

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator--().

C++ documentation:

The prefix -- operator, --it, makes the preceding item current and returns this iterator.

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

See also operator++().

impl Ge<Ref<ConstIterator>> for Iterator

unsafe fn ge(&self, other: &Ref<ConstIterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator>=(const QCborMap::ConstIterator& other) const.

impl Ge<Ref<Iterator>> for Iterator

unsafe fn ge(&self, other: &Ref<Iterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator>=(const QCborMap::Iterator& other) const.

impl Gt<Ref<ConstIterator>> for Iterator

unsafe fn gt(&self, other: &Ref<ConstIterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator>(const QCborMap::ConstIterator& other) const.

impl Gt<Ref<Iterator>> for Iterator

unsafe fn gt(&self, other: &Ref<Iterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator>(const QCborMap::Iterator& other) const.

impl Increment for Iterator

type Output = Ref<Iterator>

Output type.

unsafe fn inc(&self) -> Ref<Iterator>

The prefix ++ operator, ++it, advances the iterator to the next item in the array and returns this iterator.

Calls C++ function: QCborMap::Iterator& QCborMap::Iterator::operator++().

C++ documentation:

The prefix ++ operator, ++it, advances the iterator to the next item in the array and returns this iterator.

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

See also operator--().

impl Indirection for Iterator

type Output = CppBox<QPairOfQCborValueRefQCborValueRef>

Output type.

unsafe fn indirection(&self) -> CppBox<QPairOfQCborValueRefQCborValueRef>

Returns a modifiable reference to the current item.

Calls C++ function: QPair<QCborValueRef, QCborValueRef> QCborMap::Iterator::operator*() const.

C++ documentation:

Returns a modifiable reference to the current item.

You can change the value of an item by using operator*() on the left side of an assignment.

The return value is of type QCborValueRef, a helper class for QCborArray and QCborMap. When you get an object of type QCborValueRef, you can use it as if it were a reference to a QCborValue. If you assign to it, the assignment will apply to the element in the QCborArray or QCborMap from which you got the reference.

impl Le<Ref<ConstIterator>> for Iterator

unsafe fn le(&self, other: &Ref<ConstIterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator<=(const QCborMap::ConstIterator& other) const.

impl Le<Ref<Iterator>> for Iterator

unsafe fn le(&self, other: &Ref<Iterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator<=(const QCborMap::Iterator& other) const.

impl Lt<Ref<ConstIterator>> for Iterator

unsafe fn lt(&self, other: &Ref<ConstIterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator<(const QCborMap::ConstIterator& other) const.

impl Lt<Ref<Iterator>> for Iterator

unsafe fn lt(&self, other: &Ref<Iterator>) -> bool

Calls C++ function: bool QCborMap::Iterator::operator<(const QCborMap::Iterator& other) const.

impl PartialEq<Ref<ConstIterator>> for Iterator

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

Calls C++ function: bool QCborMap::Iterator::operator==(const QCborMap::ConstIterator& o) const.

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

This method tests for !=.

impl PartialEq<Ref<Iterator>> for Iterator

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

Calls C++ function: bool QCborMap::Iterator::operator==(const QCborMap::Iterator& o) const.

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

This method tests for !=.

impl<'_> Sub<Ref<Iterator>> for &'_ Iterator

type Output = c_longlong

The resulting type after applying the - operator.

fn sub(self, j: Ref<Iterator>) -> c_longlong

Returns the offset of this iterator relative to other.

Calls C++ function: long long QCborMap::Iterator::operator-(QCborMap::Iterator j) const.

C++ documentation:

Returns the offset of this iterator relative to other.

impl<'_> Sub<i64> for &'_ Iterator

type Output = CppBox<Iterator>

The resulting type after applying the - operator.

fn sub(self, j: c_longlong) -> CppBox<Iterator>

Returns an iterator to the item at position j steps backward from this iterator. If j is negative, the iterator goes forward.

Calls C++ function: QCborMap::Iterator QCborMap::Iterator::operator-(long long j) const.

C++ documentation:

Returns an iterator to the item at position j steps backward from this iterator. If j is negative, the iterator goes forward.

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