This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Get PerlIO::scalar to write to COWs
[perl5.git] / ext / PerlIO-scalar / scalar.pm
... / ...
CommitLineData
1package PerlIO::scalar;
2our $VERSION = '0.12';
3require XSLoader;
4XSLoader::load();
51;
6__END__
7
8=head1 NAME
9
10PerlIO::scalar - in-memory IO, scalar IO
11
12=head1 SYNOPSIS
13
14 my $scalar = '';
15 ...
16 open my $fh, "<", \$scalar or die;
17 open my $fh, ">", \$scalar or die;
18 open my $fh, ">>", \$scalar or die;
19
20or
21
22 my $scalar = '';
23 ...
24 open my $fh, "<:scalar", \$scalar or die;
25 open my $fh, ">:scalar", \$scalar or die;
26 open my $fh, ">>:scalar", \$scalar or die;
27
28=head1 DESCRIPTION
29
30A filehandle is opened but the file operations are performed "in-memory"
31on a scalar variable. All the normal file operations can be performed
32on the handle. The scalar is considered a stream of bytes. Currently
33fileno($fh) returns -1.
34
35=head1 IMPLEMENTATION NOTE
36
37C<PerlIO::scalar> only exists to use XSLoader to load C code that
38provides support for treating a scalar as an "in memory" file.
39One does not need to explicitly C<use PerlIO::scalar>.
40
41=cut