man pages section 3: Library Interfaces and Headers

TAP::Parser::YAMLish::Writer (3)

Name

TAP::Parser::YAMLish::Writer - Write YAMLish data

Synopsis

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, \@some_array );

# ...an open file handle...
$yw->write( $data, $some_file_handle );

# ...a string ...
$yw->write( $data, \$some_string );

# ...or a closure
$yw->write( $data, sub {
my $line = shift;
print "$line\n";
} );

Description

Perl Programmers Reference Guide
                                               TAP::Parser::YAMLish::Writer(3)



NAME
       TAP::Parser::YAMLish::Writer - Write YAMLish data

VERSION
       Version 3.42

SYNOPSIS
           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, \@some_array );

           # ...an open file handle...
           $yw->write( $data, $some_file_handle );

           # ...a string ...
           $yw->write( $data, \$some_string );

           # ...or a closure
           $yw->write( $data, sub {
               my $line = shift;
               print "$line\n";
           } );

DESCRIPTION
       Encodes a scalar, hash reference or array reference as YAMLish.

METHODS
   Class Methods
       "new"

        my $writer = TAP::Parser::YAMLish::Writer->new;

       The constructor "new" creates and returns an empty
       "TAP::Parser::YAMLish::Writer" object.

   Instance Methods
       "write"

        $writer->write($obj, $output );

       Encode a scalar, hash reference or array reference as YAML.

           my $writer = sub {
               my $line = shift;
               print SOMEFILE "$line\n";
           };

           my $data = {
               one => 1,
               two => 2,
               three => [ 1, 2, 3 ],
           };

           my $yw = TAP::Parser::YAMLish::Writer->new;
           $yw->write( $data, $writer );

       The  $output  argument may be:

       o   a reference to a scalar to append YAML to

       o   the handle of an open file

       o   a reference to an array into which YAML will be pushed

       o   a code reference

       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.

AUTHOR
       Andy Armstrong, <andy@hexten.net>


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       YAML::Tiny, YAML, YAML::Syck, Config::Tiny, CSS::Tiny,
       <http://use.perl.org/~Alias/journal/29427>

COPYRIGHT
       Copyright 2007-2011 Andy Armstrong.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       The full text of the license can be found in the LICENSE file included
       with this module.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                               TAP::Parser::YAMLish::Writer(3)