Perl 5 version documentation

TAP::Parser::YAMLish::Writer

NAME

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

VERSION

Version 3.42

SYNOPSIS

  1.     use TAP::Parser::YAMLish::Writer;
  2.     
  3.     my $data = {
  4.         one => 1,
  5.         two => 2,
  6.         three => [ 1, 2, 3 ],
  7.     };
  8.     
  9.     my $yw = TAP::Parser::YAMLish::Writer->new;
  10.     
  11.     # Write to an array...
  12.     $yw->write( $data, \@some_array );
  13.     
  14.     # ...an open file handle...
  15.     $yw->write( $data, $some_file_handle );
  16.     
  17.     # ...a string ...
  18.     $yw->write( $data, \$some_string );
  19.     
  20.     # ...or a closure
  21.     $yw->write( $data, sub {
  22.         my $line = shift;
  23.         print "$line\n";
  24.     } );

DESCRIPTION

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

METHODS

Class Methods

new 

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

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

Instance Methods

write

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

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

  1.     my $writer = sub {
  2.         my $line = shift;
  3.         print SOMEFILE "$line\n";
  4.     };
  5.     
  6.     my $data = {
  7.         one => 1,
  8.         two => 2,
  9.         three => [ 1, 2, 3 ],
  10.     };
  11.     
  12.     my $yw = TAP::Parser::YAMLish::Writer->new;
  13.     $yw->write( $data, $writer );

The $output argument may be:

  • a reference to a scalar to append YAML to
  • the handle of an open file
  • a reference to an array into which YAML will be pushed
  • 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>

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.