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")
val compare : t -> t -> int
val sexp_of_t : t -> Ppx_sexp_conv_lib.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
val ascending : t -> t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.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
meanslow <= t <= high
val clamp_exn : t -> min:t -> max:t -> t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween 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
val comparator : (t, comparator_witness) Base.Comparator.comparator
include Base__.Comparable_intf.Validate with type t := 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__.Comparable_intf.Polymorphic_compare with type t := t
module Map : Core_kernel.Map.S with type Key.t = t with type Key.comparator_witness = comparator_witness
module Set : Core_kernel.Set.S with type Elt.t = t with type Elt.comparator_witness = comparator_witness
include Core_kernel.Hashable.S with type t := t
include Core_kernel.Hashable.Common
val compare : t -> t -> Core_kernel__.Import.int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val hashable : t Core_kernel.Hashtbl.Hashable.t
module Table : Core_kernel.Hashtbl.S with type key = t
module Hash_set : Core_kernel.Hash_set.S with type elt = t
module Hash_queue : Core_kernel.Hash_queue.S with type key = t
include Ecaml__.Import0.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 type_
val t : 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")
val temporary_directory_for_current_buffer : unit -> t
(describe-function 'temporary-file-directory)
. Beware, if the current buffer is a tramp buffer on a remote host, then the temporary file directory will be on the remote host. This function is only available starting in emacs 26. In earlier versions, this reads the variable(describe-variable 'temporary-file-directory)
.
val temporary_directory_var : t Var.t
(describe-variable 'temporary-file-directory)
. The directory to use for writing temporary files.
val temporary_directory : unit -> t
val read : prompt:string -> t Async_kernel.Deferred.t
(describe-function 'read-file-name)