MappedFile


Description:

public MappedFile (string filename, bool writable) throws FileError

Maps a file into memory.

On UNIX, this is using the mmap function.

If writable is true, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer are not visible to other processes mapping the same file, and are not written back to the file.

Note that modifications of the underlying file might affect the contents of the MappedFile. Therefore, mapping should only be used if the file will not be modified, or if all modifications of the file are done atomically (e.g. using set_data).

If filename is the name of an empty, regular file, the function will successfully return an empty MappedFile. In other cases of size 0 (e.g. device files such as /dev/null), throws will be set to the FileError value g_file_error_inval.

Parameters:

filename

The path of the file to load, in the GLib filename encoding

writable

whether the mapping should be writable

Returns:

a newly allocated MappedFile which must be unref'd with g_mapped_file_unref, or null if the mapping failed.