Debian Codegraph @

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