TAP::Parser::Iterator(3pm) - phpMan

TAP::Parser::Iterator(3)       User Contributed Perl Documentation       TAP::Parser::Iterator(3)



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

VERSION
       Version 3.28

SYNOPSIS
         # to subclass:
         use vars qw(@ISA);
         use TAP::Parser::Iterator ();
         @ISA = qw(TAP::Parser::Iterator);
         sub _initialize {
           # see TAP::Object...
         }

         sub next_raw { ... }
         sub wait     { ... }
         sub exit     { ... }

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

METHODS
   Class Methods
       "new"

       Create an iterator.  Provided by TAP::Object.

   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
       Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.

       You must override the abstract methods as noted above.

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

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



perl v5.16.3                                2013-05-02                   TAP::Parser::Iterator(3)

Generated by $Id: phpMan.php,v 4.55 2007/09/05 04:42:51 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2024-04-23 02:40 @18.218.184.214 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)