.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TAP::Parser::YAMLish::Writer 3"
.TH TAP::Parser::YAMLish::Writer 3 "2010-01-30" "perl v5.8.4" "User Contributed Perl Documentation"
.SH "NAME"
TAP::Parser::YAMLish::Writer \- Write YAMLish data
.SH "VERSION"
.IX Header "VERSION"
Version 3.21
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use TAP::Parser::YAMLish::Writer;
.Ve
.PP
.Vb 5
\&    my $data = {
\&        one => 1,
\&        two => 2,
\&        three => [ 1, 2, 3 ],
\&    };
.Ve
.PP
.Vb 1
\&    my $yw = TAP::Parser::YAMLish::Writer->new;
.Ve
.PP
.Vb 2
\&    # Write to an array...
\&    $yw->write( $data, \e@some_array );
.Ve
.PP
.Vb 2
\&    # ...an open file handle...
\&    $yw->write( $data, $some_file_handle );
.Ve
.PP
.Vb 2
\&    # ...a string ...
\&    $yw->write( $data, \e$some_string );
.Ve
.PP
.Vb 5
\&    # ...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"
.Sh "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.
.Sh "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";
\&    };
.Ve
.PP
.Vb 5
\&    my $data = {
\&        one => 1,
\&        two => 2,
\&        three => [ 1, 2, 3 ],
\&    };
.Ve
.PP
.Vb 2
\&    my $yw = TAP::Parser::YAMLish::Writer->new;
\&    $yw->write( $data, $writer );
.Ve
.PP
The \f(CW $output \fR argument may be:
.IP "* a reference to a scalar to append \s-1YAML\s0 to" 4
.IX Item "a reference to a scalar to append YAML to"
.PD 0
.IP "* the handle of an open file" 4
.IX Item "the handle of an open file"
.IP "* a reference to an array into which \s-1YAML\s0 will be pushed" 4
.IX Item "a reference to an array into which YAML will be pushed"
.IP "* a code reference" 4
.IX Item "a code reference"
.PD
.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\-2008 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.