package vcaml

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

Parser and Serializer for Msgpack data. https://github.com/msgpack/msgpack/blob/master/spec.md

module Internal : sig ... end
module type Msgpackable = sig ... end
module Custom : sig ... end
type t =
  1. | Nil
  2. | Integer of Base.int
  3. | Int64 of Base.Int64.t
  4. | UInt64 of Base.Int64.t
  5. | Boolean of Base.bool
  6. | Floating of Base.float
  7. | Array of t Base.list
  8. | Map of (t * t) Base.list
  9. | String of Base.string
  10. | Binary of Base.Bytes.t
  11. | Extension of Custom.t
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 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 t_of_string : Base.string -> t Base.Or_error.t
val t_of_string_exn : Base.string -> t
val string_of_t_exn : ?bufsize:Base.int -> t -> Base.string