Debian Codegraph @

upstream/mageia-cauldron/man3pm/TAP::Parser::YAMLish::Writer.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::Writer 3pm"
61 .TH TAP::Parser::YAMLish::Writer 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::YAMLish::Writer \- Write YAMLish data
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& use TAP::Parser::YAMLish::Writer;
75 \&
76 \& my $data = {
77 \& one => 1,
78 \& two => 2,
79 \& three => [ 1, 2, 3 ],
80 \& };
81 \&
82 \& my $yw = TAP::Parser::YAMLish::Writer\->new;
83 \&
84 \& # Write to an array...
85 \& $yw\->write( $data, \e@some_array );
86 \&
87 \& # ...an open file handle...
88 \& $yw\->write( $data, $some_file_handle );
89 \&
90 \& # ...a string ...
91 \& $yw\->write( $data, \e$some_string );
92 \&
93 \& # ...or a closure
94 \& $yw\->write( $data, sub {
95 \& my $line = shift;
96 \& print "$line\en";
97 \& } );
98 .Ve
99 .SH DESCRIPTION
100 .IX Header "DESCRIPTION"
101 Encodes a scalar, hash reference or array reference as YAMLish.
102 .SH METHODS
103 .IX Header "METHODS"
104 .SS "Class Methods"
105 .IX Subsection "Class Methods"
106 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
107 .IX Subsection "new"
108 .PP
109 .Vb 1
110 \& my $writer = TAP::Parser::YAMLish::Writer\->new;
111 .Ve
112 .PP
113 The constructor \f(CW\*(C`new\*(C'\fR creates and returns an empty
114 \&\f(CW\*(C`TAP::Parser::YAMLish::Writer\*(C'\fR object.
115 .SS "Instance Methods"
116 .IX Subsection "Instance Methods"
117 \fR\f(CI\*(C`write\*(C'\fR\fI\fR
118 .IX Subsection "write"
119 .PP
120 .Vb 1
121 \& $writer\->write($obj, $output );
122 .Ve
123 .PP
124 Encode a scalar, hash reference or array reference as YAML.
125 .PP
126 .Vb 4
127 \& my $writer = sub {
128 \& my $line = shift;
129 \& print SOMEFILE "$line\en";
130 \& };
131 \&
132 \& my $data = {
133 \& one => 1,
134 \& two => 2,
135 \& three => [ 1, 2, 3 ],
136 \& };
137 \&
138 \& my $yw = TAP::Parser::YAMLish::Writer\->new;
139 \& $yw\->write( $data, $writer );
140 .Ve
141 .PP
142 The \f(CW $output \fR argument may be:
143 .IP \(bu 4
144 a reference to a scalar to append YAML to
145 .IP \(bu 4
146 the handle of an open file
147 .IP \(bu 4
148 a reference to an array into which YAML will be pushed
149 .IP \(bu 4
150 a code reference
151 .PP
152 If you supply a code reference the subroutine will be called once for
153 each line of output with the line as its only argument. Passed lines
154 will have no trailing newline.
155 .SH AUTHOR
156 .IX Header "AUTHOR"
157 Andy Armstrong, <[email protected]>
158 .SH "SEE ALSO"
159 .IX Header "SEE ALSO"
160 YAML::Tiny, YAML, YAML::Syck, Config::Tiny, CSS::Tiny,
161 <http://use.perl.org/~Alias/journal/29427>
162 .SH COPYRIGHT
163 .IX Header "COPYRIGHT"
164 Copyright 2007\-2011 Andy Armstrong.
165 .PP
166 This program is free software; you can redistribute
167 it and/or modify it under the same terms as Perl itself.
168 .PP
169 The full text of the license can be found in the
170 LICENSE file included with this module.