Struct qt_core::q_json_object::Iterator

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

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

C++ class: QJsonObject::iterator.

C++ documentation:

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

QJsonObject::iterator allows you to iterate over a QJsonObject and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QJsonObject, you should use QJsonObject::const_iterator. It is generally good practice to use QJsonObject::const_iterator on a non-const QJsonObject as well, unless you need to change the QJsonObject through the iterator. Const iterators are slightly faster, and improve code readability.

The default QJsonObject::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonObject function like QJsonObject::begin(), QJsonObject::end(), or QJsonObject::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_int) -> Ref<Iterator>

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

Calls C++ function: QJsonObject::iterator& QJsonObject::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 QJsonObject::iterator class provides an STL-style non-const iterator for QJsonObject.

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

C++ documentation:

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

QJsonObject::iterator allows you to iterate over a QJsonObject and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QJsonObject, you should use QJsonObject::const_iterator. It is generally good practice to use QJsonObject::const_iterator on a non-const QJsonObject as well, unless you need to change the QJsonObject through the iterator. Const iterators are slightly faster, and improve code readability.

The default QJsonObject::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonObject function like QJsonObject::begin(), QJsonObject::end(), or QJsonObject::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.

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: QJsonObject::iterator& QJsonObject::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: QJsonObject::iterator QJsonObject::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 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: QJsonObject::iterator& QJsonObject::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: QJsonObject::iterator QJsonObject::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 indirection(&self) -> CppBox<QJsonValueRef>

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

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

C++ documentation:

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

Same as value().

See also key().

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

Returns the current item's key as a const reference.

Calls C++ function: QString QJsonObject::iterator::key() const.

C++ documentation:

Returns the current item's key as a const reference.

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

See also value().

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

Constructs an uninitialized iterator.

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

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

Constructs an uninitialized iterator.

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

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

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

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

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

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

C++ documentation:

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

QJsonObject::iterator allows you to iterate over a QJsonObject and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QJsonObject, you should use QJsonObject::const_iterator. It is generally good practice to use QJsonObject::const_iterator on a non-const QJsonObject as well, unless you need to change the QJsonObject through the iterator. Const iterators are slightly faster, and improve code readability.

The default QJsonObject::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonObject function like QJsonObject::begin(), QJsonObject::end(), or QJsonObject::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.

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: QJsonObject::iterator& QJsonObject::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-().

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

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

Calls C++ function: QJsonValueRef QJsonObject::iterator::value() const.

C++ documentation:

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

You can change the value of an item by using value() on the left side of an assignment, for example:

if (i.key() == "Hello")
      i.value() = "Bonjour";

See also key() and operator*().

Trait Implementations

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

type Output = CppBox<Iterator>

The resulting type after applying the + operator.

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: QJsonObject::iterator QJsonObject::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-().

impl CppDeletable for Iterator

unsafe fn delete(&self)

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

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

C++ documentation:

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

QJsonObject::iterator allows you to iterate over a QJsonObject and to modify the value (but not the key) stored under a particular key. If you want to iterate over a const QJsonObject, you should use QJsonObject::const_iterator. It is generally good practice to use QJsonObject::const_iterator on a non-const QJsonObject as well, unless you need to change the QJsonObject through the iterator. Const iterators are slightly faster, and improve code readability.

The default QJsonObject::iterator constructor creates an uninitialized iterator. You must initialize it using a QJsonObject function like QJsonObject::begin(), QJsonObject::end(), or QJsonObject::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 (--i) makes the preceding item current and returns an iterator pointing to the new current item.

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

impl Increment for Iterator

type Output = Ref<Iterator>

Output type.

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: QJsonObject::iterator& QJsonObject::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--().

impl Indirection for Iterator

type Output = CppBox<QJsonValueRef>

Output type.

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

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

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

C++ documentation:

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

Same as value().

See also key().

impl PartialEq<Ref<ConstIterator>> for Iterator

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

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

Calls C++ function: bool QJsonObject::iterator::operator==(const QJsonObject::const_iterator& other) 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 PartialEq<Ref<Iterator>> for Iterator

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

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

Calls C++ function: bool QJsonObject::iterator::operator==(const QJsonObject::iterator& other) 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<'_> Sub<i32> for &'_ Iterator

type Output = CppBox<Iterator>

The resulting type after applying the - operator.

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: QJsonObject::iterator QJsonObject::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+().