package bigstring-unix

  1. Overview
  2. Docs
On This Page
  1. I/O
  2. Memory-map
package bigstring-unix
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Bigstring_unixSource

This is equivalent to Bigstring.t. It is redifined here to avoid depending on Bigstring.

  • since 0.3

I/O

These I/O functions are missing from the Bigarray library. They release the runtime during I/O.

Sourceval read : Unix.file_descr -> ?off:int -> ?len:int -> t -> int
Sourceval write : Unix.file_descr -> ?off:int -> ?len:int -> t -> int

Memory-map

Sourceval with_map_file : ?pos:int64 -> ?len:int -> ?mode:int -> ?flags:open_flag list -> ?shared:bool -> string -> (t -> 'a) -> 'a

with_map_file name f maps the file into memory, opening it, and call f with a slice pos.... pos+len of the bytes of the file where len is the length of the file if not provided. When f returns, the file is closed.

  • parameter pos

    offset in the file (default 0)

  • parameter shared

    if true, modifications are shared between processes that have mapped this file (requires the filedescr to be open in write mode).

  • parameter mode

    the mode for the file, if it's created

  • parameter flags

    opening flags (default rdonly) see Bigarray.Array1.map_file for more details

Sourceval map_file_descr : ?pos:int64 -> ?shared:bool -> Unix.file_descr -> int -> t

map_file_descr descr len is a lower-level access to an underlying file descriptor.

  • parameter shared

    if true, modifications are shared between processes that have mapped this file (requires the filedescr to be open in write mode). see Bigarray.Array1.map_file for more details