package core

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

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

include module type of Core_kernel.Filename
type t = Base.String.t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core_kernel.Comparable.S with type t := t with type comparator_witness = Core_kernel.String.comparator_witness
include Base.Comparable.S with type t := t with type comparator_witness = Core_kernel.String.comparator_witness
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
module Replace_polymorphic_compare = Core_kernel.Filename.Replace_polymorphic_compare
include Core_kernel.Hashable.S with type t := t
include Core_kernel.Hashable.Common with type t := t
val compare : t -> t -> Base.Int.t
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val hashable : t Base.Hashable.t
val root : Base.String.t

The path of the root.

Pathname resolution

val is_posix_pathname_component : Base.String.t -> Base.Bool.t

is_posix_pathname_component f

  • returns

    true if f is a valid path component on a POSIX compliant OS

    Note that this checks a path component, and not a full path.

    http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_169

val temp_dir_name : Base.String.t

The name of the temporary directory:

Under Unix, the value of the TMPDIR environment variable, or "/tmp" if the variable is not set.

Under Windows, the value of the TEMP environment variable, or "." if the variable is not set.

val current_dir_name : Base.String.t

The conventional name for the current directory (e.g. . in Unix).

val parent_dir_name : Base.String.t

The conventional name for the parent of the current directory (e.g. .. in Unix).

val dir_sep : Base.String.t

The directory separator (e.g. / in Unix).

concat p1 p2 returns a path equivalent to p1 ^ "/" ^ p2. In the resulting path p1 (resp. p2) has all its trailing (resp. leading) "." and "/" removed. eg: concat "a/." ".//b" => "a/b" concat "." "b" => "./b" concat "a" "." => "a/." concat "a" "/b" => "a/b"

@throws Failure if p1 is empty.

val is_relative : Base.String.t -> Base.Bool.t

Return true if the file name is relative to the current directory, false if it is absolute (i.e. in Unix, starts with /).

val is_absolute : Base.String.t -> Base.Bool.t
val is_implicit : Base.String.t -> Base.Bool.t

Return true if the file name is relative and does not start with an explicit reference to the current directory (./ or ../ in Unix), false if it starts with an explicit reference to the root directory or the current directory.

val check_suffix : Base.String.t -> Base.String.t -> Base.Bool.t

check_suffix name suff returns true if the filename name ends with the suffix suff.

val chop_suffix : Base.String.t -> Base.String.t -> Base.String.t

chop_suffix name suff removes the suffix suff from the filename name. The behavior is undefined if name does not end with the suffix suff.

val chop_extension : Base.String.t -> Base.String.t

Return the given file name without its extension. The extension is the shortest suffix starting with a period and not including a directory separator, .xyz for instance.

Raise Invalid_argument if the given name does not contain an extension.

split_extension fn return the portion of the filename before the extension and the (optional) extension. Example: split_extension "/foo/my_file" = ("/foo/my_file", None) split_extension "/foo/my_file.txt" = ("/foo/my_file", Some "txt") split_extension "/home/c.falls/my_file" = ("/home/c.falls/my_file", None)

val basename : Base.String.t -> Base.String.t

Respects the posix semantic.

Split a file name into directory name / base file name. concat (dirname name) (basename name) returns a file name which is equivalent to name. Moreover, after setting the current directory to dirname name (with Sys.chdir), references to basename name (which is a relative file name) designate the same file as name before the call to Sys.chdir.

The result is not specified if the argument is not a valid file name (for example, under Unix if there is a NUL character in the string).

val to_absolute_exn : Base.String.t -> relative_to:Base.String.t -> Base.String.t

Returns the absolute path by prepending relative_to if the path is not already absolute.

Using the result of Core.Unix.getcwd as relative_to is often a reasonable choice.

Note that to_absolute_exn may return a non-canonical path (e.g. /foo/bar/../baz).

Raises if relative_to is a relative path.

split filename returns (dirname filename, basename filename)

parts filename returns a list of path components in order. For instance: /tmp/foo/bar/baz -> "/"; "tmp"; "foo"; "bar"; "baz". The first component is always either "." for relative paths or "/" for absolute ones.

of_parts parts joins a list of path components into a path. It does roughly the opposite of parts, but they fail to be precisely mutually inverse because of ambiguities like multiple consecutive slashes and . components.

Raises an error if given an empty list.

Return a quoted version of a file name, suitable for use as one argument in a command line, escaping all meta-characters. Warning: under Windows, the output is only suitable for use with programs that follow the standard Windows quoting conventions.

See Sys.quote for an alternative implementation that is more human readable but less portable.

val realpath : string -> string

realpath path

  • returns

    the canonicalized absolute pathname of path.

  • raises Unix_error

    on errors.

val open_temp_file : ?perm:int -> ?in_dir:string -> string -> string -> string * Core_kernel.Out_channel.t

Same as Core_filename.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 : ?perm:int -> ?in_dir:string -> string -> string -> string * Caml_unix.file_descr

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

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_file : ?perm:int -> ?in_dir:string -> string -> string -> string
val temp_dir : ?perm:int -> ?in_dir:string -> string -> string -> string
val create_arg_type : ?key:'a Core_kernel.Univ_map.Multi.Key.t -> (string -> 'a) -> 'a Core_kernel.Command.Arg_type.t

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

val arg_type : string Core_kernel.Command.Arg_type.t

arg_type is create_arg_type Fn.id

OCaml

Innovation. Community. Security.