Module Ecaml.Filename

The name of a file. Functions in this module work directly on names, but do not read from or write to the filesystem.

(Info-goto-node "(elisp)File Names")

type t = string
include Ppx_compare_lib.Comparable.S with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparable.S with type t := t with type comparator_witness = Core.String.comparator_witness
include Base.Comparable.S with type t := t with type comparator_witness = Core.String.comparator_witness
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
type comparator_witness = Core.String.comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : Base.Comparable.Polymorphic_compare with type t := t
include Core.Hashable.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t Base__Ppx_compare_lib.compare
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : t Base__Ppx_hash_lib.hash_fold
val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core.Hashtbl.Hashable.t
module Table : Core.Hashtbl.S with type key = t
module Hash_set : Core.Hash_set.S with type elt = t
module Hash_queue : Core.Hash_queue.S with type key = t
include Ecaml_value.Valueable.S with type t := t
val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
val type_ : t Ecaml_value.Value.Type.t
val directory : t -> t option

(describe-function 'file-name-directory) (Info-goto-node "(elisp)File Name Components")

val directory_exn : t -> t
val nondirectory : t -> t

(describe-function 'file-name-nondirectory) (Info-goto-node "(elisp)File Name Components")

val extension_exn : t -> string

(describe-function 'file-name-extension) (Info-goto-node "(elisp)File Name Components")

val sans_extension : t -> string

(describe-function 'file-name-sans-extension) (Info-goto-node "(elisp)File Name Components")

val to_directory : t -> t

(describe-function 'file-name-as-directory) (Info-goto-node "(elisp)Directory Names")

val of_directory : t -> t

(describe-function 'directory-file-name) (Info-goto-node "(elisp)Directory Names")

val is_absolute : t -> bool

(describe-function 'file-name-absolute-p) (Info-goto-node "(elisp)Relative File Names")

val make_relative : t -> relative_to:t -> t

(describe-function 'file-relative-name) (Info-goto-node "(elisp)Relative File Names")

val expand : t -> in_dir:t -> t

(describe-function 'expand-file-name) (Info-goto-node "(elisp)File Name Expansion")

val read : prompt:string -> t Async_kernel.Deferred.t

(describe-function 'read-file-name)