mmap

Memory mapped file access.

Summary

mmap	Memory mapped file access.
Enumerations
Mode	Mode to use when opening a file.
Types
MemoryFile	Opaque type representing a memory mapped file.
Exceptions
MmapException	General exceptions for mmap module.
MmapException.InvalidFile	An invalid (NIL) file was used.
OpenFileException	An error occured while trying to open the file.
Functions
close	Close a memory mapped file.
open	Open a memory mapped file.
read	Read bytes from a memory mapped file at the given offset.
size	Return the size of a memory mapped file.
write	Write bytes to a memory mapped file at the given offset.

Mode to use when opening a file.

read	read only
write	read or write

Opaque type representing a memory mapped file.

General exceptions for mmap module.

An invalid (NIL) file was used.

An error occured while trying to open the file.

DECLARE NATIVE FUNCTION close( f: MemoryFile )

Close a memory mapped file.

DECLARE NATIVE FUNCTION open( name: String,
mode: Mode ): MemoryFile

Open a memory mapped file.

TODO: The only valid mode is currently Mode.read.

DECLARE NATIVE FUNCTION read( f: MemoryFile,
offset: Number,
count: Number ): Bytes

Read bytes from a memory mapped file at the given offset.

DECLARE NATIVE FUNCTION size( f: MemoryFile ): Number

Return the size of a memory mapped file.

DECLARE NATIVE FUNCTION write( f: MemoryFile,
offset: Number,
data: Bytes )

Write bytes to a memory mapped file at the given offset.