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 sig ... end
val compare : t ‑> t ‑> int
val sexp_of_t : t ‑> Base.Sexp.t
include Core_kernel.Comparable.S with type t := t with type comparator_witness = Core_kernel.String.comparator_witness
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable.S
include Base__.Comparable_intf.Polymorphic_compare
include Base.Comparisons.Infix
type 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 compare : t ‑> t ‑> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

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
include Base.Comparator.S with type t := t
type t
type comparator_witness
include Base__.Comparable_intf.Validate with type t := t
type 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
include Valueable.S with type t := t
type t
type 'a type_
val of_value_exn : Ecaml__.Value0.t ‑> t
val to_value : t ‑> Ecaml__.Value0.t
val type_ : t type_
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")