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