Skip to content

CountableIteratorIterator

github-actions edited this page Mar 31, 2026 · 2 revisions

Provides an iterator wrapper that is also countable.

This class SHALL extend

  • See: \IteratorIterator to decorate an existing iterator while exposing counting behavior through the composed trait. The wrapped iterator MUST be compatible with the expectations of
  • See: \IteratorIterator, and consumers SHOULD rely on this class when they need both traversal and count semantics from a single object.

  • Full name: \FastForward\Iterator\CountableIteratorIterator
  • Parent class: IteratorIterator
  • This class implements: Countable

Inherited methods

count

Counts the number of elements exposed by the inner iterator.

public count(): int

If the inner iterator implements

  • See: \Countable, this method SHALL return the value provided by that implementation. Otherwise, it MUST count elements by iterating over the iterator. If the inner iterator is not cloneable, this method SHALL wrap the current object in an

  • See: \IteratorIterator instance and count through that wrapper to avoid performing an invalid clone operation. If the inner iterator is cloneable, this method SHOULD count over a clone so that the original iterator state is preserved as much as possible.

Return Value:

the total number of elements available from the inner iterator


Clone this wiki locally