package core_unix

  1. Overview
  2. Docs
On This Page
  1. Optimization
Unix-specific portions of Core

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (7)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.1.tar.gz
md5=9370dca36f518fcea046d2752e3de22b
sha512=c4e8ce9d5885ac8fa8d554a97e1857f3a1c933e0eb5dfd4fe874412b9d09e6d0a2973b644733855553f33f5c859719228f0e6aaf3a2b7eb5befb46fc513750de

doc/core_unix.sys_unix/Sys_unix/index.html

Module Sys_unixSource

System interface.

Sourceval executable_name : string

The name of the file containing the executable currently running.

For all of the following functions, ?follow_symlinks defaults to true.

Sourceval file_exists : ?follow_symlinks:bool -> string -> [ `Yes | `No | `Unknown ]

file_exists ~follow_symlinks path

Test whether the file in path exists on the file system. If follow_symlinks is true and path is a symlink the result concerns the target of the symlink.

`Unknown is returned for files for which we cannot successfully determine whether they are on the system or not (e.g. files in directories to which we do not have read permission).

Sourceval file_exists_exn : ?follow_symlinks:bool -> string -> bool

Same as file_exists but blows up on `Unknown

Sourceval is_directory : ?follow_symlinks:bool -> string -> [ `Yes | `No | `Unknown ]

Returns `Yes if the file exists and is a directory

Sourceval is_file : ?follow_symlinks:bool -> string -> [ `Yes | `No | `Unknown ]

Returns `Yes if the file exists and is a regular file

Sourceval is_directory_exn : ?follow_symlinks:bool -> string -> bool
Sourceval is_file_exn : ?follow_symlinks:bool -> string -> bool
Sourceval remove : string -> unit

Remove the given file name from the file system.

Sourceval rename : string -> string -> unit

Rename a file. rename oldpath newpath renames the file called oldpath, giving it newpath as its new name, moving it between directories if needed. If newpath already exists, its contents will be replaced with those of oldpath. Depending on the operating system, the metadata (permissions, owner, etc) of newpath can either be preserved or be replaced by those of oldpath.

Sourceval unsafe_getenv : string -> string option

Return the value associated to a variable in the process environment.

Unlike getenv, this function returns the value even if the process has special privileges. It is considered unsafe because the programmer of a setuid or setgid program must be careful to avoid using maliciously crafted environment variables in the search path for executables, the locations for temporary files or logs, and the like.

Sourceval unsafe_getenv_exn : string -> string
Sourceval command : string -> int

Execute the given shell command and return its exit code.

Sourceval command_exn : string -> unit

command_exn command runs command and then raises an exception if it returns with nonzero exit status.

Sourceval chdir : string -> unit

Change the current working directory of the process.

Sourceval getcwd : unit -> string

Return the current working directory of the process.

Sourceval readdir : string -> string array

Return the names of all files present in the given directory. Names denoting the current directory and the parent directory ("." and ".." in Unix) are not returned. Each string in the result is a file name rather than a complete path. There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.

Sourceval fold_dir : init:'acc -> f:('acc -> string -> 'acc) -> string -> 'acc

Call readdir, and fold over the elements of the array.

  • raises Sys_error

    _ if readdir fails. As with readdir, "." and ".." are not returned raises the same exception than opendir and closedir.

Sourceval ls_dir : string -> string list

Same as readdir, but return a list rather than an array.

Sourceexception Break

Exception raised on interactive interrupt if Sys.catch_break is on.

Sourceval catch_break : bool -> unit

Warning: this function clobbers the Signal.int (SIGINT) handler. SIGINT is the signal that's sent to your program when you hit CTRL-C.

Warning: catch_break uses deep ocaml runtime magic to raise Sys.Break inside of the main execution context. Consider explicitly handling Signal.int instead. If all you want to do is terminate on CTRL-C you don't have to do any special setup, that's the default behavior.

catch_break governs whether interactive interrupt (ctrl-C) terminates the program or raises the Break exception. Call catch_break true to enable raising Break, and catch_break false to let the system terminate the program on user interrupt.

Sourceval with_async_exns : (unit -> 'a) -> 'a

with_async_exns f runs f and returns its result, in addition to causing any asynchronous Break or Stack_overflow exceptions (e.g. from finalisers, signal handlers or the GC) to be raised from the call site of with_async_exns.

Sourceval execution_mode : unit -> [ `Bytecode | `Native ]

execution_mode tests whether the code being executed was compiled natively or to bytecode.

Sourceval c_int_size : unit -> int

c_int_size returns the number of bits in a C int, as specified in header files. Note that this can be different from word_size and Nativeint.num_bits. For example, Linux x86-64 should have word_size = 64, but c_int_size () = 32.

Sourceval home_directory : unit -> string

Return the home directory, using the HOME environment variable if that is defined, and if not, using the effective user's information in the Unix password database.

Optimization
Sourceval override_argv : string array -> unit

override_argv new_argv makes subsequent calls to get_argv return new_argv.

Prior to OCaml version 4.09, this function has two noteworthy behaviors:

  • it may raise if the length of new_argv is greater than the length of argv before the call;
  • it re-uses and mutates the previous argv value instead of using the new one; and
  • it even mutates its length, which can be observed by inspecting the array returned by an earlier call to get_argv.