Debian Codegraph @

upstream/mageia-cauldron/man3pm/TAP::Parser::Iterator::Stream.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Parser::Iterator::Stream 3pm"
61 .TH TAP::Parser::Iterator::Stream 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Parser::Iterator::Stream \- Iterator for filehandle\-based TAP sources
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 4
74 \& use TAP::Parser::Iterator::Stream;
75 \& open( TEST, \*(Aqtest.tap\*(Aq );
76 \& my $it = TAP::Parser::Iterator::Stream\->new(\e*TEST);
77 \& my $line = $it\->next;
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This is a simple iterator wrapper for reading from filehandles, used by
82 TAP::Parser. Unless you\*(Aqre writing a plugin or subclassing, you probably
83 won\*(Aqt need to use this module directly.
84 .SH METHODS
85 .IX Header "METHODS"
86 .SS "Class Methods"
87 .IX Subsection "Class Methods"
88 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
89 .IX Subsection "new"
90 .PP
91 Create an iterator. Expects one argument containing a filehandle.
92 .SS "Instance Methods"
93 .IX Subsection "Instance Methods"
94 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
95 .IX Subsection "next"
96 .PP
97 Iterate through it, of course.
98 .PP
99 \fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
100 .IX Subsection "next_raw"
101 .PP
102 Iterate raw input without applying any fixes for quirky input syntax.
103 .PP
104 \fR\f(CI\*(C`wait\*(C'\fR\fI\fR
105 .IX Subsection "wait"
106 .PP
107 Get the wait status for this iterator. Always returns zero.
108 .PP
109 \fR\f(CI\*(C`exit\*(C'\fR\fI\fR
110 .IX Subsection "exit"
111 .PP
112 Get the exit status for this iterator. Always returns zero.
113 .SH ATTRIBUTION
114 .IX Header "ATTRIBUTION"
115 Originally ripped off from Test::Harness.
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 TAP::Object,
119 TAP::Parser,
120 TAP::Parser::Iterator,