package file_path

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

Relative paths are a subtype of Path.t and therefore also of string.

type comparator_witness = Types.Relative.comparator_witness
include Types.Type with type t := t and type comparator_witness := comparator_witness
include Ppx_compare_lib.Equal.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val t_sexp_grammar : t Sexplib0.Sexp_grammar.t
include Core.Comparator.S with type t := t with type comparator_witness := comparator_witness
module Expert : sig ... end

Path types have straightforward to_string and sexp_of_t behavior. of_string and t_of_sexp raise on invalid input (e.g. containing null characters), and guarantee canonical output (e.g. no redundant slashes).

to_string is the identity function. of_string returns its input when the input is a valid string in canonical form.

include Core.Identifiable.S with type t := t and type comparator_witness := comparator_witness
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_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Base.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Base.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
include Core.Comparable.S_binable with type t := t with type comparator_witness := comparator_witness
include Base.Comparable.S with type t := t with type comparator_witness := 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 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 with type comparator_witness := comparator_witness
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
include Core.Comparator.S with type t := t with type comparator_witness := comparator_witness
include Core.Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S with type t := 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
module Table : Core.Hashtbl.S_binable with type key = t
module Hash_set : Core.Hash_set.S_binable with type elt = t
module Hash_queue : Core.Hash_queue.S with type key = t
include Core.Invariant.S with type t := t
val invariant : t -> unit
val arg_type : t Core.Command.Arg_type.t

Command-line argument. Supports tab-completion.

include Core.Quickcheckable.S with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t
val dot : t

The current directory, i.e. ..

val dot_dot : t

The parent directory, i.e. ...

val basename : t -> Types.Part.t

Returns the final part of the given path.

val dirname : t -> t option

Returns all parts of the given path but the final one, or None if the path has only one part.

val dirname_exn : t -> t

Returns all parts of the given path but the final one, or raises if the path has only one part.

val dirname_or_error : t -> t Core.Or_error.t

Returns all parts of the given path but the final one, or returns an error if the path has only one part.

val dirname_defaulting_to_dot : t -> t

Returns all parts of the given path but the final one, or dot if the path has only one part.

val top_dir : t -> Types.Part.t option

Returns the first part of a multiple-part path, or None if given a single-part path.

val top_dir_exn : t -> Types.Part.t

Returns the first part of a multiple-part path, or raises if given a single-part path.

val top_dir_or_error : t -> Types.Part.t Core.Or_error.t

Returns the first part of a multiple-part path, or returns an error if given a single-part path.

val top_dir_defaulting_to_dot : t -> Types.Part.t

Returns the first part of a multiple-part path, or Part.dot if given a single-part path.

val all_but_top_dir : t -> t option

Returns all but the first part of a multiple-part relative path, or None if given a single-part path.

val all_but_top_dir_exn : t -> t

Returns all but the first part of a multiple-part relative path, or raises if given a single-part path.

val all_but_top_dir_or_error : t -> t Core.Or_error.t

Returns all but the first part of a multiple-part relative path, or returns an error if given a single-part path.

val all_but_top_dir_defaulting_to_self : t -> t

Returns all but the first part of a multiple-part relative path, or returns the path unchanged if given a single-part path.

val top_dir_and_all_but_top_dir : t -> (Types.Part.t * t) option

Like Option.both (top_dir t) (all_but_top_dir t). Allocates Some at most once.

val append_to_basename_exn : t -> string -> t

Adds the given string as a suffix of the path's basename. Raises if the string contains characters that are illegal for a path part.

val prepend_part : Types.Part.t -> t -> t

Adds a part to the beginning of the path.

val append_part : t -> Types.Part.t -> t

Adds a part to the end of the path.

val append : t -> t -> t

Appends the parts of two paths.

val is_prefix : t -> prefix:t -> bool

Reports if the parts of prefix are a non-strict prefix of the parts of the other argument.

val is_suffix : t -> suffix:t -> bool

Reports if the parts of suffix are a non-strict suffix of the parts of the other argument.

val chop_prefix : t -> prefix:t -> t option

Returns all parts of the given path after prefix, or None if prefix is not a prefix of the path's parts. If the path equals prefix, returns dot.

val chop_prefix_exn : t -> prefix:t -> t

Returns all parts of the given path after prefix, or raises if prefix is not a prefix of the path's parts. If the path equals prefix, returns dot.

val chop_prefix_or_error : t -> prefix:t -> t Core.Or_error.t

Returns all parts of the given path after prefix, or returns an error if prefix is not a prefix of the path's parts. If the path equals prefix, returns dot.

val chop_prefix_if_exists : t -> prefix:t -> t

Returns all parts of the given path after prefix, or returns the path unchanged if prefix is not a prefix of the path's parts. If the path equals prefix, returns dot.

val chop_suffix : t -> suffix:t -> t option

Returns all parts of the given path before suffix, or None if suffix is not a suffix of the path's parts. If the path equals suffix, returns dot.

val chop_suffix_exn : t -> suffix:t -> t

Returns all parts of the given path before suffix, or raises if suffix is not a suffix of the path's parts. If the path equals suffix, returns dot.

val chop_suffix_or_error : t -> suffix:t -> t Core.Or_error.t

Returns all parts of the given path before suffix, or returns an error if suffix is not a suffix of the path's parts. If the path equals suffix, returns dot.

val chop_suffix_if_exists : t -> suffix:t -> t

Returns all parts of the given path before suffix, or returns the path unchanged if suffix is not a suffix of the path's parts. If the path equals suffix, returns dot.

val simplify_dot : t -> t

Removes . parts from the given path. Returns . if the given path consists only of one or more . parts.

val simplify_dot_and_dot_dot_naively : t -> t

Removes . parts from the given path. Cancels out .. parts with preceding parts (that are neither . nor ..). Does not check the file system; in the presence of symlinks, the resulting path may not be equivalent. Returns . if all parts are canceled out.

val of_part : Types.Part.t -> t

Returns a path consisting of the single given part.

val to_parts : t -> Types.Part.t list

Produces the parts of the path.

val to_parts_nonempty : t -> Types.Part.t Nonempty_list.t

Produces the parts of the path.

val of_parts : Types.Part.t list -> t option

Returns a relative path consisting of the given one or more parts, or None if the list of parts is empty.

val of_parts_exn : Types.Part.t list -> t

Returns a relative path consisting of the given one or more parts, or raises if the list of parts is empty.

val of_parts_or_error : Types.Part.t list -> t Core.Or_error.t

Returns a relative path consisting of the given one or more parts, or returns an error if the list of parts is empty.

val of_parts_defaulting_to_dot : Types.Part.t list -> t

Returns a relative path consisting of the given one or more parts, or dot if the list of parts is empty.

val of_parts_nonempty : Types.Part.t Nonempty_list.t -> t

Returns a relative path consisting of the given one or more parts.

val number_of_parts : t -> int

Equivalent to List.length (to_parts t), without allocating.