Debian Codegraph @

upstream/opensuse-tumbleweed/man3/TAP::Parser::YAMLish::Reader.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::YAMLish::Reader 3pm"
61 .TH TAP::Parser::YAMLish::Reader 3pm 2026-03-09 "perl v5.42.1" "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::YAMLish::Reader \- Read YAMLish data from iterator
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 Note that parts of this code were derived from YAML::Tiny with the
76 permission of Adam Kennedy.
77 .SH METHODS
78 .IX Header "METHODS"
79 .SS "Class Methods"
80 .IX Subsection "Class Methods"
81 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
82 .IX Subsection "new"
83 .PP
84 The constructor \f(CW\*(C`new\*(C'\fR creates and returns an empty
85 \&\f(CW\*(C`TAP::Parser::YAMLish::Reader\*(C'\fR object.
86 .PP
87 .Vb 1
88 \& my $reader = TAP::Parser::YAMLish::Reader\->new;
89 .Ve
90 .SS "Instance Methods"
91 .IX Subsection "Instance Methods"
92 \fR\f(CI\*(C`read\*(C'\fR\fI\fR
93 .IX Subsection "read"
94 .PP
95 .Vb 1
96 \& my $got = $reader\->read($iterator);
97 .Ve
98 .PP
99 Read YAMLish from a TAP::Parser::Iterator and return the data structure it
100 represents.
101 .PP
102 \fR\f(CI\*(C`get_raw\*(C'\fR\fI\fR
103 .IX Subsection "get_raw"
104 .PP
105 .Vb 1
106 \& my $source = $reader\->get_source;
107 .Ve
108 .PP
109 Return the raw YAMLish source from the most recent \f(CW\*(C`read\*(C'\fR.
110 .SH AUTHOR
111 .IX Header "AUTHOR"
112 Andy Armstrong, <[email protected]>
113 .PP
114 Adam Kennedy wrote YAML::Tiny which provided the template and many of
115 the YAML matching regular expressions for this module.
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 YAML::Tiny, YAML, YAML::Syck, Config::Tiny, CSS::Tiny,
119 <http://use.perl.org/~Alias/journal/29427>
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright 2007\-2011 Andy Armstrong.
123 .PP
124 Portions copyright 2006\-2008 Adam Kennedy.
125 .PP
126 This program is free software; you can redistribute
127 it and/or modify it under the same terms as Perl itself.
128 .PP
129 The full text of the license can be found in the
130 LICENSE file included with this module.