Module Ecaml.FilenameSource

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")

Sourcetype t = string
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval 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
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval 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.

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

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

Sourceval 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).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t with type comparator_witness = Core.String.comparator_witness
Sourcetype comparator_witness = Core.String.comparator_witness
Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
include Core.Hashable.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
Sourceval hashable : t Base.Hashable.t
Sourcemodule Table : Core.Hashtbl.S with type key = t
Sourcemodule Hash_set : Core.Hash_set.S with type elt = t
include Ecaml_value.Valueable.S with type t := t
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Ecaml_value.Value.Type.t
Sourceval directory : t -> t option

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

Sourceval directory_exn : t -> t
Sourceval nondirectory : t -> t

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

Sourceval extension : t -> string option

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

Sourceval extension_exn : t -> string

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

Sourceval sans_extension : t -> string

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

Sourceval to_directory : t -> t

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

Sourceval of_directory : t -> t

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

Sourceval is_absolute : t -> bool

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

Sourceval make_relative : t -> relative_to:t -> t

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

Sourceval expand : t -> in_dir:[ `Default_directory_in_current_buffer | `This of string ] -> t

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

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

(describe-function 'read-file-name)