Index of types

the underlying applicative

the type of strings that type t is a substring of

If blit : (src, dst) blit, then blit ~src ~src_pos ~len ~dst ~dst_pos blits len values from src starting at position src_pos to dst at position dst_pos.

blito is like blit, except that the src_pos, src_len, and dst_pos are optional (hence the "o" in "blito").

Used for specifying a bound (either upper or lower) as inclusive, exclusive, or unbounded.

to make function signatures easier to read

just an alias, needed when t gets shadowed below

Generators for functions, annotated with sexps that describe the functions.

never_returns should be used as the return type of functions that don't return and might block forever, rather than 'a or _.

no_raise is the identity, but by using 'a no_raise in a sexpable type, the resulting use sexp_of_no_raise protects the conversion of 'a to a sexp so that if it fails, one gets a sexp with an error message about the failure, rather than an exception being raised.

Every type in this module besides the following two represent permission sets; these two represent who is allowed to write in the Write.t and Immutable.t types.

The options type is used to make Accessors_generic flexible as to whether a comparator is required to be passed to certain functions.

Beware that when unpacking sexps, one cannot tell if one is at the end of an atom until one hits punctuation.

We don't expose bin_io for write due to a naming conflict with the functions exported by bin_io for read_write.

with_return f allows for something like the return statement in C within f.

seed specifies how to initialize a pseudo-random number generator.

If sub : (src, dst) sub, then sub ~src ~pos ~len returns a sequence of type dst containing len characters of src starting at pos.

The 's parameter is shared across all values stored in the map.

An Elt.t represents an element that was added to a timing wheel.

The timing-wheel implementation uses an array of "levels", where level i is an array of length 2^b_i, where the b_i are the "level bits" specified via Level_bits.create_exn [b_0, b_1; ...].

The result of a validation.

The type of an unpack buffer.

The sexps and strings look like integers.

type 'a t is the type of objects, where each object is part of an equivalence class that is associated with a single value of type 'a.

Core_int63.t is immediate on 64bit boxes and so plays nicely with the GC write barrier.

'a is a function's expected return type, and 'b is often an error message string.

A pointer to a tuple in a pool.

A pool.

Serialization and comparison of an Error force the error's lazy message.

Serialization and comparison force the lazy message.

of_sexp and bin_io functions aren't supplied for heaps due to the difficulties in reconstructing the correct comparison function when de-serializing.

a hash-queue, where the values are of type 'a

A "force_once" is a thunk that can only be forced once.

The type of a flat queue.

A Slot.t represents a slot in a tuple type.

The type of a flat-tuple array.

t_of_sexp is not supported, because of the difficulty involved in recreating the comparison function.

sexp_of_t uses a global table of sexp converters.

This type represents values with two possibilities.

A Tree.t contains just the tree data structure that a set is based on, without including the comparator.

The type of a set.

compare on lists is lexicographic.

An alias for the type of characters.

The meaning of the 'perms parameter is as usual (see the Perms module for more details) with the non-obvious difference that you don't need any permissions to extract the length of an array.

Serialization of a bounded int table using bin_io or sexp preserves num_keys, but only takes space proportional to the length of the table.

Type of bigstrings

The abstract type of buffers.

A Backtrace.t is a snapshot of the stack obtained by calling Backtrace.get.

'f is the type of a function that consumes the list of arguments and returns an 'r.

<:sexp_of< _ t_now >> displays only now t, not all the alarms.