package file_path

  1. Overview
  2. Docs
package file_path
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type Types = Types.S
module type Part = Part.S
module type Relative = Relative.S
module type Absolute = Absolute.S
module type Path = sig ... end
module type Operators = Operators.S
module type Stable = sig ... end
module type S = sig ... end
include S
module Types : Types.S

Everything below uses the types and subtyping relationships of Types.

module Part : Part.S with module Types := Types
module Relative : Relative.S with module Types := Types
module Absolute : Absolute.S with module Types := Types

Paths are a subtype of string.

type t = Types.Path.t
type comparator_witness = Types.Path.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
val of_string : string -> t
val to_string : t -> string
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
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
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
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 : sig ... end
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 : 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_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 Base__Invariant_intf.inv
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 root : t

The root directory, i.e. /.

val dot : t

The current directory, i.e. ..

val dot_dot : t

The parent directory, i.e. ...

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

Returns the final part of the given path, or None if given root.

val basename_exn : t -> Types.Part.t

Returns the final part of the given path, or raises if given root.

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

Returns the final part of the given path, or returns an error if given root.

val basename_defaulting_to_dot : t -> Types.Part.t

Returns the final part of the given path, or Part.dot if given root.

val dirname : t -> t option

Returns all parts of the given path but the final one, or None if given root or a relative path of a single part.

val dirname_exn : t -> t

Returns all parts of the given path but the final one, or raises if given root or a relative path of a single 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 given root or a relative path of a single part.

val dirname_defaulting_to_dot_or_root : t -> t

Returns all parts of the given path but the final one, or root if given root, or dot if given a relative path of a single part.

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

Like Option.both (dirname t) (basename 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 t is root and therefore has no basename, or if the string contains characters that are illegal for a path part.

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

Adds a part to the end of the path.

val append : t -> Types.Relative.t -> t

Appends the parts of a relative path to the end of the path.

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, and the paths are both absolute or both relative.

val is_suffix : t -> suffix:Types.Relative.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 -> Types.Relative.t option

Returns all parts of the given path after prefix, or None if prefix is not a prefix of the path's parts. Always returns None if the path and prefix do not match in absolute/relative status. If the path equals prefix, returns dot.

val chop_prefix_exn : t -> prefix:t -> Types.Relative.t

Returns all parts of the given path after prefix, or raises if prefix is not a prefix of the path's parts. Always raises if the path and prefix do not match in absolute/relative status. If the path equals prefix, returns dot.

val chop_prefix_or_error : t -> prefix:t -> Types.Relative.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. Always returns an error if the path and prefix do not match in absolute/relative status. 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:Types.Relative.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:Types.Relative.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:Types.Relative.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:Types.Relative.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 is a relative path consisting 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 ..). Removes any .. parts immediately following a leading /. Does not check the file system; in the presence of symlinks, the resulting path may not be equivalent. Returns . if the given path is a relative path and all parts are canceled out.

val of_part_relative : Types.Part.t -> t

Returns a relative path consisting of the given part.

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

Produces the parts of the path.

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

Constructs an absolute path from the given parts.

val of_parts_relative : 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_relative_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_relative_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_relative_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_relative_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.

val make_absolute : t -> under:Types.Absolute.t -> Types.Absolute.t

If t is absolute, returns t as an absolute path. If t is relative, returns Absolute.append under t.

val make_relative : t -> if_under:Types.Absolute.t -> Types.Relative.t option

If t is relative, returns t as a relative path. If t is absolute, returns chop_prefix t ~prefix:if_under.

val make_relative_exn : t -> if_under:Types.Absolute.t -> Types.Relative.t

If t is relative, returns t as a relative path. If t is absolute, returns chop_prefix_exn t ~prefix:if_under.

val make_relative_or_error : t -> if_under:Types.Absolute.t -> Types.Relative.t Core.Or_error.t

If t is relative, returns t as a relative path. If t is absolute, returns chop_prefix_or_error t ~prefix:if_under.

val make_relative_if_possible : t -> if_under:Types.Absolute.t -> t

If t is relative, returns t as a relative path. If t is absolute, returns chop_prefix_if_exists t ~prefix:if_under.

val is_absolute : t -> bool

Reports if a path is absolute, i.e. starts with a slash.

val is_relative : t -> bool

Reports if a path is relative, i.e. does not start with a slash.

val of_absolute : Types.Absolute.t -> t

Converts an absolute path to a path. Is the identity function.

val of_relative : Types.Relative.t -> t

Converts a relative path to a path. Is the identity function.

val to_absolute : t -> Types.Absolute.t option

Returns t as an absolute path, or None if it is relative.

val to_relative : t -> Types.Relative.t option

Returns t as a relative path, or None if it is absolute.

val to_absolute_exn : t -> Types.Absolute.t

Returns t as an absolute path, or raises if it is relative.

val to_relative_exn : t -> Types.Relative.t

Returns t as a relative path, or raises if it is absolute.

val to_absolute_or_error : t -> Types.Absolute.t Core.Or_error.t

Returns t as an absolute path, or returns an error if it is relative.

val to_relative_or_error : t -> Types.Relative.t Core.Or_error.t

Returns t as a relative path, or returns an error if it is absolute.

module Variant : sig ... end
val to_variant : t -> Variant.t

Converts a path to a variant.

val of_variant : Variant.t -> t

Converts a variant to a path.

module Operators : Operators.S with module Types := Types
module Stable : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct