<mapped-file> ( path -- mmap ) - Factor Documentation

<mapped-file> ( path -- mmap )
Memory-mapped files

Vocabulary
io.mmap

Inputs

path	a pathname string

Outputs

mmap	a mapped-file

Generic word contract
Opens a file and maps its contents into memory. The length is permitted to exceed the length of the file on disk, in which case the remaining space is padded with zero bytes.

Notes
You must call dispose when you are finished working with the returned object, to reclaim resources. The with-mapped-file provides an abstraction which can close the mapped file for you.

Errors
Throws an error if a memory mapping could not be established.

Definition

USING: io.mmap.private ;

IN: io.mmap

: <mapped-file> ( path -- mmap )
[ (mapped-file-r/w) ] prepare-mapped-file ; inline