diff options
Diffstat (limited to 'upstream/archlinux/man3/TAP::Parser::YAMLish::Writer.3perl')
| -rw-r--r-- | upstream/archlinux/man3/TAP::Parser::YAMLish::Writer.3perl | 167 |
1 files changed, 167 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/TAP::Parser::YAMLish::Writer.3perl b/upstream/archlinux/man3/TAP::Parser::YAMLish::Writer.3perl new file mode 100644 index 00000000..6f0345d0 --- /dev/null +++ b/upstream/archlinux/man3/TAP::Parser::YAMLish::Writer.3perl @@ -0,0 +1,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. |