1. class
  2. Relay
  3. \
  4. BlessScanIterator

BlessScanIterator

final class BlessScanIterator implements Iterator

Lazily iterates the keys of BLESS SCAN, fetching one page at a time. Rewinding restarts the scan once a key has been consumed.

Methods

mixed
current()

Returns the current key name, or null when the scan has finished.

mixed
key()

Returns the position of the current key, or null when the scan has finished.

void
next()

Moves to the next key.

void
rewind()

Restarts the scan if any keys have been consumed.

bool
valid()

Returns whether there is a current key, fetching pages as needed.

Details

at line 4983
mixed current()

Returns the current key name, or null when the scan has finished.

Return Value

mixed

at line 4990
mixed key()

Returns the position of the current key, or null when the scan has finished.

Return Value

mixed

at line 4997
void next()

Moves to the next key.

Return Value

void

at line 5004
void rewind()

Restarts the scan if any keys have been consumed.

Return Value

void

at line 5011
bool valid()

Returns whether there is a current key, fetching pages as needed.

Return Value

bool