Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

TAP::Parser::YAMLish::Writer

Name TAP::Parser::YAMLish::Writer
Version 3.42
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/TAP/Parser/YAMLish/Writer.pm
Is Core No
Search CPAN for this module TAP::Parser::YAMLish::Writer
Documentation TAP::Parser::YAMLish::Writer
Module Details TAP::Parser::YAMLish::Writer


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:

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>


SEE ALSO

the YAML::Tiny manpage, YAML, the YAML::Syck manpage, the Config::Tiny manpage, the CSS::Tiny manpage, 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.

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024