This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clarify the PerlIO::scalar docs (suggested by Elizabeth
[perl5.git] / ext / PerlIO / scalar / scalar.pm
... / ...
CommitLineData
1package PerlIO::scalar;
2our $VERSION = '0.01';
3use XSLoader ();
4XSLoader::load 'PerlIO::scalar';
51;
6__END__
7
8=head1 NAME
9
10PerlIO::scalar - support module for in-memory IO.
11
12=head1 SYNOPSIS
13
14 open($fh,"<",\$scalar);
15 open($fh,">",\$scalar);
16
17or
18
19 open($fh,"<:scalar",\$scalar);
20 open($fh,">:scalar",\$scalar);
21
22=head1 DESCRIPTION
23
24C<PerlIO::scalar> only exists to use XSLoader to load C code that provides
25support for treating a scalar as an "in memory" file.
26
27All normal file operations can be performed on the handle. The scalar
28is considered a stream of bytes. Currently fileno($fh) returns C<undef>.
29
30=cut
31
32