Documentation

Exception thrown when mmap fails.

Exception thrown when munmap fails.

mmap - map files or devices into memory.

The returned memory should be freed with c_munmap after use.

This is the raw C function, and its return value must be checked according to man mmap.

See mmap for a variant that turns bad return values into exceptions.

munmap - unmap mmap'ed memory.

This is the raw C function, and its return value must be checked according to man mmap.

See munmap for a variant that turns bad return values into exceptions.

Convenience around c_mmap, throwing a MmapException on a negative return value.

Convenience around c_munmap, throwing a MunmapException on a negative return value.

Describes the desired memory protection of the mapping (and must not conflict with the open mode of the file).

Can be combined using the Monoid instance (<>).

Pages may be executed.

Pages may be read.

Pages may be written.

Pages may not be accessed.

Determines whether updates to the mapping are visible to other processes mapping the same region, and whether updates are carried through to the underlying file.

This behavior is determined by including exactly one of mapShared and mapPrivate.

Share this mapping. Updates to the mapping are visible to other processes that map the file, and are carried through to the underlying file. The file may not actually be updated until msync(2) or munmap() is called..

Create a private copy-on-write mapping. Updates to the mapping are not visible to other processes mapping the same file, and are not carried through to the underlying file. It is unspecified whether changes made to the file after the mmap() call are visible in the mapped region.

And MmapSharedFlag with one or more MmapOptionalFlags.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

See man mmap for a description.

An MmapSharedFlag with one or more MmapOptionalFlags.

Create MmapFlags to be passed to c_mmap from an MmapSharedFlag and one or more MmapOptionalFlags (combine them via (<>), mempty for none).