IO::TieCombine (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/IO::TieCombine.3pm".)

NAME

IO::TieCombine - produce tied (and other) separate but combined variables

VERSION

version 1.005

SYNOPSIS

First, we set up a bunch of access points:

  my $hub = IO::TieCombine->new;

  my $str_ref  = $hub->scalar_ref('x');
  my $fh       = $hub->fh('x');
  my $callback = $hub->callback('x');

  tie my $scalar, $hub, 'x';
  tie local *STDOUT, $hub, 'x';

  tie local *STDERR, $hub, 'err';

Then we write to things:

  $$str_ref .= 'And ';
  print $fh "now ";
  $callback->('for ');
  $scalar .= 'something ';
  print "completely ";
  warn "different.\n";

And then:

  $hub->combined_contents;    # And now for something completely different.
  $hub->slot_contents('x');   # And now for something completely
  $hub->slot_contents('err'); # different.

!! Because of a serious problem with Perl 5.10.0, output sent to a tied filehandle using "say" will not have the expected newline. 5.10.1 or later is needed. Since 5.10.0 is broken in so many other ways, you should really upgrade anyway.

!! Because of a different problem with Perls 5.10.1 - 5.16.3, if you send output to a tied filehandle using "say", and "$\" is undefined (which is the default), "$\" will not be restored to "undef" after the "say"! This means that once you've used "say" to print to any tied filehandle, you have corrupted the global state of your program. Either start your program by setting "$\" to an empty string, which should be safe, or upgrade to 5.18.0.

METHODS

new

The constructor takes no arguments.

combined_contents

This method returns the contents of all collected data.

slot_contents

  my $str = $hub->slot_contents( $slot_name );

This method returns the contents of all collected data for the named slot.

clear_slot

  $hub->clear_slot( $slot_name );

This sets the slot back to an empty string.

fh

  my $fh = $hub->fh( $slot_name );

This method returns a reference to a tied filehandle. When printed to, output is collected in the named slot.

scalar_ref

  my $str_ref = $hub->scalar_ref( $slot_name );

This method returns a reference to scalar. When appended to, the new content is collected in the named slot. Attempting to alter the string other than by adding new content to its end will result in an exception.

callback

  my $code = $hub->callback( $slot_name );

AUTHOR

Ricardo <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Ricardo

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