Moving :mmap out of core binary into a module
[perl.git] / ext / PerlIO-mmap / mmap.pm
1 package PerlIO::mmap;
2 use strict;
3 use warnings;
4 our $VERSION = '0.010';
5
6 use XSLoader;
7 XSLoader::load(__PACKAGE__, __PACKAGE__->VERSION);
8
9 1;
10
11 __END__
12
13 =head1 NAME
14
15 PerlIO::mmap - Memory mapped IO
16
17 =head1 SYNOPSIS
18
19  open my $fh, '<:mmap', $filename;
20
21 =head1 DESCRIPTION
22
23 This 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
27 C<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