xref: /openbsd-src/gnu/usr.bin/perl/ext/PerlIO-scalar/scalar.pm (revision 3d61058aa5c692477b6d18acfbbdb653a9930ff9)
143003dfeSmillertpackage PerlIO::scalar;
2*3d61058aSafresh1our $VERSION = '0.32';
343003dfeSmillert1;
443003dfeSmillert__END__
543003dfeSmillert
643003dfeSmillert=head1 NAME
743003dfeSmillert
843003dfeSmillertPerlIO::scalar - in-memory IO, scalar IO
943003dfeSmillert
1043003dfeSmillert=head1 SYNOPSIS
1143003dfeSmillert
1243003dfeSmillert   my $scalar = '';
1343003dfeSmillert   ...
1443003dfeSmillert   open my $fh, "<",  \$scalar or die;
1543003dfeSmillert   open my $fh, ">",  \$scalar or die;
1643003dfeSmillert   open my $fh, ">>", \$scalar or die;
1743003dfeSmillert
1843003dfeSmillertor
1943003dfeSmillert
2043003dfeSmillert   my $scalar = '';
2143003dfeSmillert   ...
2243003dfeSmillert   open my $fh, "<:scalar",  \$scalar or die;
2343003dfeSmillert   open my $fh, ">:scalar",  \$scalar or die;
2443003dfeSmillert   open my $fh, ">>:scalar", \$scalar or die;
2543003dfeSmillert
2643003dfeSmillert=head1 DESCRIPTION
2743003dfeSmillert
2843003dfeSmillertA filehandle is opened but the file operations are performed "in-memory"
2943003dfeSmillerton a scalar variable.  All the normal file operations can be performed
3043003dfeSmillerton the handle. The scalar is considered a stream of bytes.  Currently
3143003dfeSmillertfileno($fh) returns -1.
3243003dfeSmillert
33eac174f2Safresh1Attempting to open a read-only scalar for writing will fail, and if
34eac174f2Safresh1warnings are enabled, produce a warning.
35eac174f2Safresh1
3643003dfeSmillert=head1 IMPLEMENTATION NOTE
3743003dfeSmillert
38*3d61058aSafresh1C<PerlIO::scalar> only exists as a stub. One does not need to explicitly
39*3d61058aSafresh1C<use PerlIO::scalar>.
4043003dfeSmillert
4143003dfeSmillert=cut
42