.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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 3"
.TH TAP::Parser::YAMLish::Writer 3 "2015-12-30" "perl v5.16.3" "User Contributed Perl Documentation"
.\" 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.36
.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"
\fI\f(CI\*(C`new\*(C'\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"
\fI\f(CI\*(C`write\*(C'\fI\fR
.IX Subsection "write"
.PP
.Vb 1
\& $writer\->write($obj, $output );
.Ve
.PP
Encode a scalar, hash reference or array reference as \s-1YAML.\s0
.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 \s-1YAML\s0 to
.IP "\(bu" 4
the handle of an open file
.IP "\(bu" 4
a reference to an array into which \s-1YAML\s0 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, \s-1YAML\s0, 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
\&\s-1LICENSE\s0 file included with this module.