package core_unix

  1. Overview
  2. Docs
package core_unix
Legend:
Library
Module
Module type
Parameter
Class
Class type

Warning! this library assumes we are in a POSIX compliant OS.

val realpath : string -> string

realpath path

  • returns

    the canonicalized absolute pathname of path.

  • raises Unix_error

    on errors.

val open_temp_file : ?close_on_exec:bool -> ?perm:int -> ?in_dir:string -> string -> string -> string * Core.Out_channel.t

Same as temp_file, but returns both the name of a fresh temporary file, and an output channel opened (atomically) on this file. This function is more secure than temp_file: there is no risk that the temporary file will be modified (e.g. replaced by a symbolic link) before the program opens it.

val open_temp_file_fd : ?close_on_exec:bool -> ?perm:int -> ?in_dir:string -> string -> string -> string * Caml_unix.file_descr

Similar to open_temp_file, but returns a Unix file descriptor open in read&write mode instead of an Out_channel.t.

val temp_file : ?perm:int -> ?in_dir:string -> string -> string -> string

temp_file ?perm ?in_dir_name prefix suffix

Returns the name of a fresh temporary file in the temporary directory. The base name of the temporary file is formed by concatenating prefix, then .tmp., then a 6-digit hex number, then suffix. The temporary file is created empty. The file is guaranteed to be fresh, i.e. not already existing in the directory.

  • parameter in_dir

    the directory in which to create the temporary file. The default is temp_dir_name

  • parameter perm

    the permission of the temporary file. The default value is 0o600 (readable and writable only by the file owner)

    Note that prefix and suffix will be changed when necessary to make the final filename valid POSIX.

    temp_dir is the same as temp_file but creates a temporary directory.

val temp_dir : ?perm:int -> ?in_dir:string -> string -> string -> string
val create_arg_type : ?key:'a Core.Univ_map.Multi.Key.t -> (string -> 'a) -> 'a Core.Command.Arg_type.t

create_arg_type's resulting Arg_type.t does bash autocompletion, via compgen.

val arg_type : string Core.Command.Arg_type.t

arg_type is create_arg_type Fn.id

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct