package jenga

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

The type and operations on filesystem paths.

module Rel : sig ... end
module Abs : sig ... end
type t
val t_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> t
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
val bin_t : t Core.Bin_prot.Type_class.t
val bin_read_t : t Core.Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Core.Bin_prot.Read.reader
val bin_reader_t : t Core.Bin_prot.Type_class.reader
val bin_size_t : t Core.Bin_prot.Size.sizer
val bin_write_t : t Core.Bin_prot.Write.writer
val bin_writer_t : t Core.Bin_prot.Type_class.writer
val bin_shape_t : Core.Bin_prot.Shape.t
include Core.Hashable_binable with type t := t
val hash_fold_t : Ppx_hash_lib.Std.Hash.state -> t -> Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core_kernel__.Hashtbl.Hashable.t
module Hash_queue : Core_kernel.Hash_queue.S with type Key.t = t
include Core.Comparable_binable with type t := t
include Base.Comparable.S 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
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
type comparator_witness
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 : sig ... end
include Core_kernel.Comparator.S with type t := t with type comparator_witness := comparator_witness
val of_relative : Rel.t -> t
val of_absolute : Abs.t -> t
val case : t -> [ `relative of Rel.t | `absolute of Abs.t ]
val is_absolute : t -> bool
val the_root : t
val unix_root : t
val root_relative : string -> t
val absolute : string -> t
val relative : dir:t -> string -> t
val split : t -> t * string
val dirname : t -> t
val basename : t -> string
val to_string : t -> string

leading / for absolute; not for relative

val reach_from : dir:t -> t -> string

reach_from ~dir t = x means relative_or_absolute ~dir x = t

val is_descendant : dir:t -> t -> bool

is_descendant ~dir t = true means that reach_from ~dir t = Some x and relative ~dir x = t

val relative_or_absolute : dir:t -> string -> t
module Repo : sig ... end
val to_absolute_string : t -> string
val of_absolute_string : string -> t
val is_a_root : t -> bool

is_a_root t = (t = the_root) || (t = unix_root)

module With_store : 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