NAME
PerlIO::Util - A selection of general PerlIO utilities
VERSION
This document describes PerlIO::Util version 0.41
SYNOPSIS
use PerlIO::Util;
# utility layers
open IN, "+<:flock", ...; # with flock(IN, LOCK_EX)
open IN, "+<:creat :excl", ...; # with O_CREAT | O_EXCL
open OUT, ">:tee", $file, \$scalar, \*STDERR;
print OUT "foo"; # print to $file, $scalar and *STDERR
# utility routines
my $fh = PerlIO::Util->open('<', $file); # it dies on fail
STDOUT->push_layer(scalar => \my $s); # it dies on fail
print "foo";
print STDOUT->pop_layer(); # => scalar
print $s; # => fooDESCRIPTION
PerlIO::Util provides general PerlIO utilities: utility layers and utility methods.
Utility layers are a part of PerlIO::Util, but you don't need to say use PerlIO::Util for loading them. They will be automatically loaded.
UTILITY LAYERS
:flock
Easy interface to flock().
See PerlIO::flock.
:creat
Use of O_CREAT without Fcntl.
See PerlIO::creat.
:excl
Use of O_EXCL without Fcntl.
See PerlIO::excl.
:tee
Multiplex output layer.
See PerlIO::tee.
:dir
PerlIO interface to directory functions.
See PerlIO::dir.
:reverse
Reverse input iterator.
See PerlIO::reverse.
UTILITY METHODS
PerlIO::Util->open(mode, args)
Calls built-in open(), and returns an anonymus IO::Handle instance. It dies on fail.
Unlike Perl's open() (nor IO::File's), mode is always required.
PerlIO::Util->known_layers( )
Returns the known layer names.
FILEHANDLE->get_layers( )
Returns the names of the PerlIO layers on FILEHANDLE.
See "Querying the layers of filehandles" in PerlIO.
FILEHANDLE->push_layer(layer [ => arg])
Equivalent to binmode(*FILEHANDLE, ':layer(arg)'), but accepts any type of arg, e.g. a scalar reference to the :scalar layer.
This method dies on fail. Otherwise, it returns FILEHANDLE.
FILEHANDLE->pop_layer( )
Equivalent to binmode(*FILEHANDLE, ':pop'). It removes a top level layer from FILEHANDLE, but note that you cannot remove dummy layers such as :utf8 or :flock.
This method returns the name of the poped layer.
DEPENDENCIES
Perl 5.8.1 or later, and a C compiler.
BUGS
No bugs have been reported.
Please report any bugs or feature requests to <gfuji (at) cpan.org>, or through the web interface at http://rt.cpan.org/.
SEE ALSO
PerlIO::flock, PerlIO::creat, PerlIO::excl, PerlIO::tee, PerlIO::dir, PerlIO::reverse.
PerlIO for push_layer() and pop_layer().
perliol for implementation details.
AUTHOR
Goro Fuji (藤 吾郎) <gfuji (at) cpan.org>
LICENCE AND COPYRIGHT
Copyright (c) 2008, Goro Fuji <gfuji (at) cpan.org>. Some rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.