Struct qt_core::q_cbor_array::Iterator

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

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

C++ class: QCborArray::Iterator.

C++ documentation:

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

QCborArray::Iterator allows you to iterate over a QCborArray and to modify the array item associated with the iterator. If you want to iterate over a const QCborArray, use QCborArray::ConstIterator instead. It is generally a good practice to use QCborArray::ConstIterator on a non-const QCborArray as well, unless you need to change the QCborArray through the iterator. Const iterators are slightly faster and improve code readability.

Iterators are initialized by using a QCborArray function like QCborArray::begin(), QCborArray::end(), or QCborArray::insert(). Iteration is only possible after that.

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

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

Implementations

impl Iterator

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

Available 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: QCborArray::Iterator& QCborArray::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>

Available 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: QCborArray::Iterator& QCborArray::Iterator::operator=(const QCborArray::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>

Available 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: QCborArray::Iterator& QCborArray::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>

Available 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: QCborArray::Iterator QCborArray::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>

Available 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: QCborArray::Iterator& QCborArray::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>

Available 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: QCborArray::Iterator QCborArray::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 index(&self, j: c_longlong) -> CppBox<QCborValueRef>

Available 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 item at a position j steps forward from the item pointed to by this iterator.

Calls C++ function: QCborValueRef QCborArray::Iterator::operator[](long long j).

C++ documentation:

Returns a modifiable reference to the item at a position j steps forward from the item pointed to by this iterator.

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

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 operator+().

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

Available 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: QCborValueRef QCborArray::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 new() -> CppBox<Iterator>

Available 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 QCborArray::Iterator::Iterator().

C++ documentation:

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 QCborArray::begin() and QCborArray::end().

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

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Makes a copy of other.

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

C++ documentation:

Makes a copy of other.

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

Available 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* QCborArray::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>

Available 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: QCborArray::Iterator& QCborArray::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-().

Trait Implementations

impl Add<i64> for &Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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: QCborArray::Iterator QCborArray::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+=().

type Output = CppBox<Iterator>

The resulting type after applying the + operator.

impl CppDeletable for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

unsafe fn delete(&self)

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

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

C++ documentation:

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

QCborArray::Iterator allows you to iterate over a QCborArray and to modify the array item associated with the iterator. If you want to iterate over a const QCborArray, use QCborArray::ConstIterator instead. It is generally a good practice to use QCborArray::ConstIterator on a non-const QCborArray as well, unless you need to change the QCborArray through the iterator. Const iterators are slightly faster and improve code readability.

Iterators are initialized by using a QCborArray function like QCborArray::begin(), QCborArray::end(), or QCborArray::insert(). Iteration is only possible after that.

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

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

impl Decrement for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

Calls C++ function: QCborArray::Iterator& QCborArray::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++().

type Output = Ref<Iterator>

Output type.

impl Ge<Ref<ConstIterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Ge<Ref<Iterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Gt<Ref<ConstIterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Gt<Ref<Iterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Increment for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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: QCborArray::Iterator& QCborArray::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--().

type Output = Ref<Iterator>

Output type.

impl Indirection for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

Returns a modifiable reference to the current item.

Calls C++ function: QCborValueRef QCborArray::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.

type Output = CppBox<QCborValueRef>

Output type.

impl Le<Ref<ConstIterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Le<Ref<Iterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Lt<Ref<ConstIterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl Lt<Ref<Iterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

impl PartialEq<Ref<ConstIterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Ref<Iterator>> for Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Ref<Iterator>> for &Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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

Returns the offset of this iterator relative to other.

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

C++ documentation:

Returns the offset of this iterator relative to other.

type Output = i64

The resulting type after applying the - operator.

impl Sub<i64> for &Iterator

Available on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

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: QCborArray::Iterator QCborArray::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-=().

type Output = CppBox<Iterator>

The resulting type after applying the - operator.