package jenga

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

Alias.t is a symbolic target, ie build-goal which is not associated with any generated files. It is used as a way of asking jenga to do an arbitrary Dep computation, for instance build a set of files ("all the libraries in the tree" for instance) and run actions that produce no target, like tests. The user indicates an alias on the command line with a leading period. So for example ".DEFAULT" or ".runtest". Aliases are directory relative.

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_read_t : t Core.Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Core.Bin_prot.Read.reader
val bin_size_t : t Core.Bin_prot.Size.sizer
val bin_write_t : t Core.Bin_prot.Write.writer
val bin_shape_t : Core.Bin_prot.Shape.t
include Core.Comparable with type t := t
include Base.Comparable.S with type t := t
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 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
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
include Core.Hashable with type t := t
include Core_kernel.Hashable.Common with type t := t
val compare : t -> t -> Base.Int.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_kernel.Hashtbl.S with type key = t
module Hash_set : Core_kernel.Hash_set.S with type elt = t
val split : t -> Path.Rel.t * string

split a/b/.DEFAULT is ("a/b", "DEFAULT").

to_string a/b/.DEFAULT is "a/b/.DEFAULT".

val to_string : t -> string

to_string a/b/.DEFAULT is "a/b/.DEFAULT".

val directory : t -> Path.Rel.t

basename "a/b/.DEFAULT" is ".DEFAULT".

val basename : t -> string

basename "a/b/.DEFAULT" is ".DEFAULT".

val create : dir:Path.t -> string -> t
val default : dir:Path.t -> t
OCaml

Innovation. Community. Security.