This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Added an additional #ifndef based on comments by Jarkko and
[perl5.git] / ext / PerlIO / scalar / scalar.pm
CommitLineData
e934609f 1package PerlIO::scalar;
5735c168 2our $VERSION = '0.04';
f6c77cf1 3use XSLoader ();
e934609f 4XSLoader::load 'PerlIO::scalar';
f6c77cf1
NIS
51;
6__END__
b3d30bf7
NIS
7
8=head1 NAME
9
a920b0f7 10PerlIO::scalar - in-memory IO, scalar IO
b3d30bf7
NIS
11
12=head1 SYNOPSIS
13
a920b0f7
JH
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;
8ec39683
RGS
19
20or
21
a920b0f7
JH
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;
b3d30bf7
NIS
27
28=head1 DESCRIPTION
29
a920b0f7
JH
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 C<undef>.
b3d30bf7 34
a920b0f7 35=head1 IMPLEMENTATION NOTE
b3d30bf7 36
a920b0f7
JH
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>.
b3d30bf7 40
a920b0f7 41=cut