Debian Codegraph @

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