This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Version bumping thanks to the Coverity deluge.
[perl5.git] / ext / PerlIO-mmap / mmap.pm
CommitLineData
307764ab
LT
1package PerlIO::mmap;
2use strict;
3use warnings;
9fadc397 4our $VERSION = '0.012';
307764ab
LT
5
6use XSLoader;
7XSLoader::load(__PACKAGE__, __PACKAGE__->VERSION);
8
91;
10
11__END__
12
13=head1 NAME
14
15PerlIO::mmap - Memory mapped IO
16
17=head1 SYNOPSIS
18
19 open my $fh, '<:mmap', $filename;
20
21=head1 DESCRIPTION
22
23This layer does C<read> and C<write> operations by mmap()ing the file if possible, but falls back to the default behavior if not.
24
25=head1 IMPLEMENTATION NOTE
26
27C<PerlIO::mmap> only exists to use XSLoader to load C code that provides support for using memory mapped IO. One does not need to explicitly C<use PerlIO::mmap;>.
28
29=cut
30