Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Iterator::Stream.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "TAP::Parser::Iterator::Stream 3perl"
58 .TH TAP::Parser::Iterator::Stream 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 TAP::Parser::Iterator::Stream \- Iterator for filehandle\-based TAP sources
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 4
71 \& use TAP::Parser::Iterator::Stream;
72 \& open( TEST, \*(Aqtest.tap\*(Aq );
73 \& my $it = TAP::Parser::Iterator::Stream\->new(\e*TEST);
74 \& my $line = $it\->next;
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This is a simple iterator wrapper for reading from filehandles, used by
79 TAP::Parser. Unless you're writing a plugin or subclassing, you probably
80 won't need to use this module directly.
81 .SH METHODS
82 .IX Header "METHODS"
83 .SS "Class Methods"
84 .IX Subsection "Class Methods"
85 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
86 .IX Subsection "new"
87 .PP
88 Create an iterator. Expects one argument containing a filehandle.
89 .SS "Instance Methods"
90 .IX Subsection "Instance Methods"
91 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
92 .IX Subsection "next"
93 .PP
94 Iterate through it, of course.
95 .PP
96 \fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
97 .IX Subsection "next_raw"
98 .PP
99 Iterate raw input without applying any fixes for quirky input syntax.
100 .PP
101 \fR\f(CI\*(C`wait\*(C'\fR\fI\fR
102 .IX Subsection "wait"
103 .PP
104 Get the wait status for this iterator. Always returns zero.
105 .PP
106 \fR\f(CI\*(C`exit\*(C'\fR\fI\fR
107 .IX Subsection "exit"
108 .PP
109 Get the exit status for this iterator. Always returns zero.
110 .SH ATTRIBUTION
111 .IX Header "ATTRIBUTION"
112 Originally ripped off from Test::Harness.
113 .SH "SEE ALSO"
114 .IX Header "SEE ALSO"
115 TAP::Object,
116 TAP::Parser,
117 TAP::Parser::Iterator,