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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
.\" -*- 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::YAMLish::Writer 3perl"
.TH TAP::Parser::YAMLish::Writer 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::YAMLish::Writer \- Write YAMLish data
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use TAP::Parser::YAMLish::Writer;
\&
\& my $data = {
\& one => 1,
\& two => 2,
\& three => [ 1, 2, 3 ],
\& };
\&
\& my $yw = TAP::Parser::YAMLish::Writer\->new;
\&
\& # Write to an array...
\& $yw\->write( $data, \e@some_array );
\&
\& # ...an open file handle...
\& $yw\->write( $data, $some_file_handle );
\&
\& # ...a string ...
\& $yw\->write( $data, \e$some_string );
\&
\& # ...or a closure
\& $yw\->write( $data, sub {
\& my $line = shift;
\& print "$line\en";
\& } );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Encodes a scalar, hash reference or array reference as YAMLish.
.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
.Vb 1
\& my $writer = TAP::Parser::YAMLish::Writer\->new;
.Ve
.PP
The constructor \f(CW\*(C`new\*(C'\fR creates and returns an empty
\&\f(CW\*(C`TAP::Parser::YAMLish::Writer\*(C'\fR object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`write\*(C'\fR\fI\fR
.IX Subsection "write"
.PP
.Vb 1
\& $writer\->write($obj, $output );
.Ve
.PP
Encode a scalar, hash reference or array reference as YAML.
.PP
.Vb 4
\& my $writer = sub {
\& my $line = shift;
\& print SOMEFILE "$line\en";
\& };
\&
\& my $data = {
\& one => 1,
\& two => 2,
\& three => [ 1, 2, 3 ],
\& };
\&
\& my $yw = TAP::Parser::YAMLish::Writer\->new;
\& $yw\->write( $data, $writer );
.Ve
.PP
The \f(CW $output \fR argument may be:
.IP \(bu 4
a reference to a scalar to append YAML to
.IP \(bu 4
the handle of an open file
.IP \(bu 4
a reference to an array into which YAML will be pushed
.IP \(bu 4
a code reference
.PP
If you supply a code reference the subroutine will be called once for
each line of output with the line as its only argument. Passed lines
will have no trailing newline.
.SH AUTHOR
.IX Header "AUTHOR"
Andy Armstrong, <andy@hexten.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
YAML::Tiny, YAML, YAML::Syck, Config::Tiny, CSS::Tiny,
<http://use.perl.org/~Alias/journal/29427>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2007\-2011 Andy Armstrong.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
LICENSE file included with this module.
|
