TAP::Pa...:Writer(3pm)

🌸 NAME 🌸

Okay so bestie, welcome to the TAP::Parser::YAMLish::Writer(3pm) page from the Perl Programmers Reference Guide. πŸ’– The module is TAP::Parser::YAMLish::Writer β€” Write YAMLish data. That’s the whole name-and-purpose situation, and honestly? Iconic. ✨

✨ VERSION ✨

Version 3.50. Noted, no cap. πŸ’…

πŸŽ€ 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 πŸ¦‹

It encodes a scalar, hash reference or array reference as YAMLish. That’s the vibe: you hand it data, it gives you YAMLish output. 🫢

🌈 METHODS 🌈

πŸ’œ Class Methods πŸ’œ

✨ new ✨

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

The constructor new creates and returns an empty TAP::Parser::YAMLish::Writer object. Clean, simple, main-character energy. πŸ’…

🌸 Instance Methods 🌸

πŸ’– write πŸ’–

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

Encodes a scalar, hash reference or array reference as YAML. Bestie, it’s giving β€œturn my data into YAML” and I’m obsessed. ✨

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:

  • 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. Lowkey important, so don’t forget it. 🫢

πŸ’€ AUTHOR πŸ’€

Andy Armstrong, <andy@hexten.net>. Shoutout to the author, fr fr. πŸ‘‘

πŸ”₯ SEE ALSO πŸ”₯

YAML::Tiny, YAML, YAML::Syck, Config::Tiny, CSS::Tiny, <http://use.perl.org/~Alias/journal/29427>. Go read, iykyk. πŸ¦‹

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. πŸ’–


okay bye bestie πŸ’– β€” this page’s source/version is perl v5.42.3, and it’s dated 2026-11-03. ✨🫢

πŸ“¦ where this page comes from