Struct qt_core::q_json_array::Iterator

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

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

C++ class: QJsonArray::iterator.

C++ documentation:

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

QJsonArray::iterator allows you to iterate over a QJsonArray and to modify the array item associated with the iterator. If you want to iterate over a const QJsonArray, use QJsonArray::const_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::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonArray function like QJsonArray::begin(), QJsonArray::end(), 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 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.

Implementations

impl Iterator

pub unsafe fn a(&self) -> Ptr<QJsonArray>

Returns the value of the a field.

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

Advances the iterator by j items. (If j is negative, the iterator goes backward.)

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator+=(int j).

C++ documentation:

Advances the iterator by j items. (If j is negative, the iterator goes backward.)

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

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

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

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator=(const QJsonArray::iterator& other).

C++ documentation:

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

QJsonArray::iterator allows you to iterate over a QJsonArray and to modify the array item associated with the iterator. If you want to iterate over a const QJsonArray, use QJsonArray::const_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::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonArray function like QJsonArray::begin(), QJsonArray::end(), 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 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.

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

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

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator--().

C++ documentation:

The prefix – operator (–i) makes the preceding item current and returns an iterator pointing to the new current item.

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

See also operator++().

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

This is an overloaded function.

Calls C++ function: QJsonArray::iterator QJsonArray::iterator::operator--(int arg1).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn i(&self) -> c_int

Returns the value of the i field.

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

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

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator++().

C++ documentation:

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

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

See also operator--().

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

This is an overloaded function.

Calls C++ function: QJsonArray::iterator QJsonArray::iterator::operator++(int arg1).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn index(&self, j: c_int) -> CppBox<QJsonValueRef>

Returns a modifiable reference to the item at offset j from the item pointed to by this iterator (the item at position *this + j).

Calls C++ function: QJsonValueRef QJsonArray::iterator::operator[](int j) const.

C++ documentation:

Returns a modifiable reference to 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.

The return value is of type QJsonValueRef, a helper class for QJsonArray and QJsonObject. When you get an object of type QJsonValueRef, you can use it as if it were a reference to a QJsonValue. If you assign to it, the assignment will apply to the character in the QJsonArray of QJsonObject from which you got the reference.

See also operator+().

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

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

Calls C++ function: QJsonValueRef QJsonArray::iterator::operator*() const.

C++ documentation:

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

Same as value().

See also key().

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

Constructs an uninitialized iterator.

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

pub unsafe fn new_2a( array: impl CastInto<Ptr<QJsonArray>>, index: c_int ) -> CppBox<Iterator>

Constructs an uninitialized iterator.

Calls C++ function: [constructor] void QJsonArray::iterator::iterator(QJsonArray* array, int index).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for iterator::iterator():

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

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

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

Calls C++ function: [constructor] void QJsonArray::iterator::iterator(const QJsonArray::iterator& other).

C++ documentation:

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

QJsonArray::iterator allows you to iterate over a QJsonArray and to modify the array item associated with the iterator. If you want to iterate over a const QJsonArray, use QJsonArray::const_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::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonArray function like QJsonArray::begin(), QJsonArray::end(), 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 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.

pub unsafe fn set_a(&self, value: impl CastInto<Ptr<QJsonArray>>)

Sets the value of the a field.

pub unsafe fn set_i(&self, value: c_int)

Sets the value of the i field.

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

Makes the iterator go back by j items. (If j is negative, the iterator goes forward.)

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator-=(int j).

C++ documentation:

Makes the iterator go back by j items. (If j is negative, the iterator goes forward.)

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

Trait Implementations

impl Add<i32> for &Iterator

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

Returns an iterator to the item at j positions forward from this iterator. (If j is negative, the iterator goes backward.)

Calls C++ function: QJsonArray::iterator QJsonArray::iterator::operator+(int j) const.

C++ documentation:

Returns an iterator to the item at j positions forward from this iterator. (If j is negative, the iterator goes backward.)

This operation can be slow for large j values.

See also operator-().

type Output = CppBox<Iterator>

The resulting type after applying the + operator.

impl CppDeletable for Iterator

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QJsonArray::iterator::~iterator().

C++ documentation:

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

QJsonArray::iterator allows you to iterate over a QJsonArray and to modify the array item associated with the iterator. If you want to iterate over a const QJsonArray, use QJsonArray::const_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::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonArray function like QJsonArray::begin(), QJsonArray::end(), 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 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.

impl Decrement for Iterator

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

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

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator--().

C++ documentation:

The prefix – operator (–i) makes the preceding item current and returns an iterator pointing to the new current item.

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

See also operator++().

type Output = Ref<Iterator>

Output type.

impl Ge<Ref<ConstIterator>> for Iterator

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

Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator>=(const QJsonArray::const_iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the other iterator.

impl Ge<Ref<Iterator>> for Iterator

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

Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator>=(const QJsonArray::iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is greater than or equal to the item pointed to by the other iterator.

impl Gt<Ref<ConstIterator>> for Iterator

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

Returns true if the item pointed to by this iterator is greater than the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator>(const QJsonArray::const_iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is greater than the item pointed to by the other iterator.

impl Gt<Ref<Iterator>> for Iterator

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

Returns true if the item pointed to by this iterator is greater than the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator>(const QJsonArray::iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is greater than the item pointed to by the other iterator.

impl Increment for Iterator

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

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

Calls C++ function: QJsonArray::iterator& QJsonArray::iterator::operator++().

C++ documentation:

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

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

See also operator--().

type Output = Ref<Iterator>

Output type.

impl Indirection for Iterator

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

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

Calls C++ function: QJsonValueRef QJsonArray::iterator::operator*() const.

C++ documentation:

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

Same as value().

See also key().

type Output = CppBox<QJsonValueRef>

Output type.

impl Le<Ref<ConstIterator>> for Iterator

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

Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator<=(const QJsonArray::const_iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the other iterator.

impl Le<Ref<Iterator>> for Iterator

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

Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator<=(const QJsonArray::iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is less than or equal to the item pointed to by the other iterator.

impl Lt<Ref<ConstIterator>> for Iterator

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

Returns true if the item pointed to by this iterator is less than the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator<(const QJsonArray::const_iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is less than the item pointed to by the other iterator.

impl Lt<Ref<Iterator>> for Iterator

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

Returns true if the item pointed to by this iterator is less than the item pointed to by the other iterator.

Calls C++ function: bool QJsonArray::iterator::operator<(const QJsonArray::iterator& other) const.

C++ documentation:

Returns true if the item pointed to by this iterator is less than the item pointed to by the other iterator.

impl PartialEq<Ref<ConstIterator>> for Iterator

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 QJsonArray::iterator::operator==(const QJsonArray::const_iterator& o) const.

C++ documentation:

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

See also operator!=().

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

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

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

Calls C++ function: bool QJsonArray::iterator::operator==(const QJsonArray::iterator& o) const.

C++ documentation:

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

See also operator!=().

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

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

Calls C++ function: int QJsonArray::iterator::operator-(QJsonArray::iterator j) const.

type Output = i32

The resulting type after applying the - operator.

impl Sub<i32> for &Iterator

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

Returns an iterator to the item at j positions backward from this iterator. (If j is negative, the iterator goes forward.)

Calls C++ function: QJsonArray::iterator QJsonArray::iterator::operator-(int j) const.

C++ documentation:

Returns an iterator to the item at j positions backward from this iterator. (If j is negative, the iterator goes forward.)

This operation can be slow for large j values.

See also operator+().

type Output = CppBox<Iterator>

The resulting type after applying the - operator.