bonsai

A library for building dynamic webapps, using Js_of_ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library bonsai
Module Bonsai . Private . Node_path
type t

Represents the shortest unambiguous path through the Computation.t data structure, including the path through any contained Value.ts. Several of the constructors in Computation.t only contain a single inner computation or value; thus, keeping track of these segments in all the paths is often unnecessary. Thus, we can more properly model this path as with two parts:

  • the list of choices made; nodes which do not require a choice do not make it into the list.
  • a number representing the amount of nodes descended into after the last choice point.

Whenever a choice point gets added, we reset the number of nodes descended back to 0, since that number is no longer helpful for keeping the paths unique.

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 Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparable.S_binable 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 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
type 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

The of_string and to_string functions operate on short, yet semi-human-readable strings.

For example:

{ choices = [ 1; 2; 3]; descend = 4 }

is serialized to "1-2-3_4"

include Core.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
type builder
val empty : builder

The empty node path.

val choice_point : builder -> int -> builder

Adds a choice point to that input path. The provided number says which of the choices at that point was taken. When traversing a computation or value, if any case has multiple recursive calls, you should add a choice point to the path built up in each of those calls, with each call using a different number.

val descend : builder -> builder

Adds an extra segment to the input path. All such segments get forgotten when the next choice point is added.

val finalize : builder -> t