TAP::Parser::Iterator(3pm) Perl Programmers Reference Guide TAP::Parser::Iterator(3pm)

# [NAME](#NAME)

TAP::Parser::Iterator - Base class for TAP source iterators

# [VERSION](#VERSION)

Version 3.52

# [SYNOPSIS](#SYNOPSIS)

```
  # to subclass:
  use TAP::Parser::Iterator ();
  use base 'TAP::Parser::Iterator';
  sub _initialize {
    # see TAP::Object...
  }
  sub next_raw { ... }
  sub wait     { ... }
  sub exit     { ... }
```

# [DESCRIPTION](#DESCRIPTION)

This is a simple iterator base class that defines TAP::Parser's iterator API. Iterators are typically created from TAP::Parser::SourceHandlers.

# [METHODS](#METHODS)

## [Class Methods](#Class_Methods)

*"new"*

Create an iterator. Provided by TAP::Object.

## [Instance Methods](#Instance_Methods)

*"next"*

```
 while ( my $item = $iter->next ) { ... }
```

Iterate through it, of course.

*"next\_raw"*

**Note:** this method is abstract and should be overridden.

```
 while ( my $item = $iter->next_raw ) { ... }
```

Iterate raw input without applying any fixes for quirky input syntax.

*"handle\_unicode"*

If necessary switch the input stream to handle unicode. This only has any effect for I/O handle based streams.

The default implementation does nothing.

*"get\_select\_handles"*

Return a list of filehandles that may be used upstream in a **select()** call to signal that this Iterator is ready. Iterators that are not handle-based should return an empty list.

The default implementation does nothing.

*"wait"*

**Note:** this method is abstract and should be overridden.

```
 my $wait_status = $iter->wait;
```

Return the "wait" status for this iterator.

*"exit"*

**Note:** this method is abstract and should be overridden.

```
 my $wait_status = $iter->exit;
```

Return the "exit" status for this iterator.

# [SUBCLASSING](#SUBCLASSING)

Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.

You must override the abstract methods as noted above.

## [Example](#Example)

TAP::Parser::Iterator::Array is probably the easiest example to follow. There's not much point repeating it here.

# [SEE ALSO](#SEE_ALSO)

TAP::Object, TAP::Parser, TAP::Parser::Iterator::Array, TAP::Parser::Iterator::Stream, TAP::Parser::Iterator::Process,

2026-10-27 perl v5.44.0

---

Document: TAP::Parser::Iterator(3pm) from perl 5.44.0-r4 (Chainguard OS)
Source: https://github.com/Perl/perl5.git