1. class
  2. MongoDB
  3. \
  4. BSON
  5. \
  6. Iterator

Iterator

Since: 1.16.0

final class Iterator implements Iterator (View source)

Methods

TValue
current()

Return the current element

TKey|null
key()

Return the key of the current element

void
next()

Move forward to next element

void
rewind()

Rewind the Iterator to the first element

bool
valid()

Checks if current position is valid

void
__wakeup()

No description

Details

at line 13
final TValue current()

Return the current element

Return Value

TValue

Can return any type.

at line 15
final TKey|null key()

Return the key of the current element

Return Value

TKey|null

TKey on success, or null on failure.

at line 17
final void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 19
final void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 21
final bool valid()

Checks if current position is valid

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 23
final void __wakeup()

No description

Return Value

void