Index of types

An alarm is a piece of data that calls a user function at the end of each major GC cycle.

Currently, the official distribution only supports Native and Bytecode, but it can be other backends with alternative compilers, for example, javascript.

backtrace_slot [Printexc]

The abstract type backtrace_slot represents a single slot of a backtrace.

channel [Event]

The type of communication channels carrying values of type 'a.

color [Graphics]

A color is specified by its R, G, B components.

control [Gc]

The GC parameters are given as a control record.

data [Weak.S]

The type of the elements stored in the table.

doc [Arg]

elt [Set.S]

The type of the set elements.

elt [MoreLabels.Set.S]

equal [Ephemeron.GenHashTable]

error [Dynlink]

event [Graphics]

To specify events to wait for.

event [Event]

The type of communication events returning a result of type 'a.

extern_flags [Marshal]

The flags to the Marshal.to_* functions below.

file_name [Scanf.Scanning]

A convenient alias to designate a file name.

Abstract data corresponding to a pretty-printer (also called a formatter) and all its machinery.

formatter_out_functions [Format]

The set of output functions specific to a formatter: the out_string function performs all the pretty-printer string output. It is called with a string s, a start position p, and a number of characters n; it is supposed to output characters p to p + n - 1 of s., the out_flush function flushes the pretty-printer output device., out_newline is called to open a new line when the pretty-printer splits the line., the out_spaces function outputs spaces when a break hint leads to spaces instead of a line split. It is called with the number of spaces to output., the out_indent function performs new line indentation when the pretty-printer splits the line. It is called with the indentation value of the new line. By default: fields out_string and out_flush are output device specific; (e.g. Pervasives.output_string and Pervasives.flush for a Pervasives.out_channel device, or Buffer.add_substring and Pervasives.ignore for a Buffer.t output device),, field out_newline is equivalent to out_string "\n" 0 1;, fields out_spaces and out_indent are equivalent to out_string (String.make n ' ') 0 n.

formatter_tag_functions [Format]

The semantic tag handling functions specific to a formatter: mark versions are the 'tag-marking' functions that associate a string marker to a tag in order for the pretty-printing engine to write those markers as 0 length tokens in the output device of the formatter.

fpclass [Pervasives]

The five classes of floating-point numbers, as determined by the Pervasives.classify_float function.

image [Graphics]

The abstract type for images, in internal representation.

in_channel [Scanf.Scanning]

The notion of input channel for the Scanf module: those channels provide all the machinery necessary to read from any source of characters, including a Pervasives.in_channel value.

in_channel [Pervasives]

The type of input channel.

key [MoreLabels.Map.S]

key [MoreLabels.Hashtbl.SeededS]

key [MoreLabels.Hashtbl.S]

key [Map.S]

The type of the map keys.

key [Hashtbl.SeededS]

key [Hashtbl.S]

key [Arg]

lexbuf [Lexing]

The type of lexer buffers.

linking_error [Dynlink]

location [Printexc]

The type of location information found in backtraces.

obj_t [Obj.Ephemeron]

alias for Obj.t

open_flag [Pervasives]

Opening modes for Pervasives.open_out_gen and Pervasives.open_in_gen.

out_channel [Pervasives]

The type of output channel.

position [Lexing]

A value of type position describes a point in a source file.

raw_backtrace [Printexc]

The abstract type raw_backtrace stores a backtrace in a low-level format, instead of directly exposing them as string as the get_backtrace() function does.

raw_backtrace_slot [Printexc]

This type allows direct access to raw backtrace slots, without any conversion in an OCaml-usable data-structure.

ref [Pervasives]

The type of references (mutable indirection cells) containing a value of type 'a.

regexp [Str]

The type of compiled regular expressions.

result [Pervasives]

scanbuf [Scanf.Scanning]

The type of scanning buffers.

scanner [Scanf]

The type of formatted input scanners: ('a, 'b, 'c, 'd) scanner is the type of a formatted input function that reads from some formatted input channel according to some format string; more precisely, if scan is some formatted input function, then scan ic fmt f applies f to all the arguments specified by format string fmt, when scan has read those arguments from the Scanf.Scanning.in_channel formatted input channel ic.

signal_behavior [Sys]

What to do when receiving a signal: Signal_default: take the default behavior (usually: abort the program), Signal_ignore: ignore the signal, Signal_handle f: call function f, giving it the signal number as argument.

spec [Arg]

The concrete type describing the behavior associated with a keyword.

split_result [Str]

stat [Gc]

The memory management counters are returned in a stat record.

statistics [MoreLabels.Hashtbl]

statistics [Hashtbl]

status [Graphics]

To report events.

symbolic_output_buffer [Format]

The output buffer of a symbolic pretty-printer.

symbolic_output_item [Format]

Items produced by symbolic pretty-printers

t [Weak.S]

The type of tables that contain elements of type data.

t [Weak]

The type of arrays of weak pointers (weak arrays).

t [Uchar]

The type for Unicode characters.

t [StringLabels]

An alias for the type of strings.

t [String]

An alias for the type of strings.

t [Stream]

The type of streams holding values of type 'a.

t [Stack]

The type of stacks containing elements of type 'a.

t [Spacetime.Series]

Type representing a file that will hold a series of heap snapshots together with additional information required to interpret those snapshots.

t [Set.OrderedType]

The type of the set elements.

t [Set.S]

The type of sets.

t [Random.State]

The type of PRNG states.

t [Queue]

The type of queues containing elements of type 'a.

t [Printexc.Slot]

t [Obj.Ephemeron]

an ephemeron cf Ephemeron

t [Obj]

t [Nativeint]

An alias for the type of native integers.

t [Mutex]

The type of mutexes.

t [MoreLabels.Set.S]

t [MoreLabels.Map.S]

t [MoreLabels.Hashtbl.SeededS]

t [MoreLabels.Hashtbl.S]

t [MoreLabels.Hashtbl]

t [Map.OrderedType]

The type of the map keys.

t [Map.S]

The type of maps from type key to type 'a.

t [Lazy]

A value of type 'a Lazy.t is a deferred computation, called a suspension, that has a result of type 'a.

t [Int64]

An alias for the type of 64-bit integers.

t [Int32]

An alias for the type of 32-bit integers.

t [Hashtbl.SeededHashedType]

The type of the hashtable keys.

t [Hashtbl.HashedType]

The type of the hashtable keys.

t [Hashtbl.SeededS]

t [Hashtbl.S]

t [Hashtbl]

The type of hash tables from type 'a to type 'b.

t [Ephemeron.Kn]

an ephemeron with an arbitrary number of keys of the same type

t [Ephemeron.K2]

an ephemeron with two keys

t [Ephemeron.K1]

an ephemeron with one key

t [Digest]

The type of digests: 16-character strings.

t [Complex]

The type of complex numbers.

t [Char]

An alias for the type of characters.

t [BytesLabels]

An alias for the type of byte sequences.

t [Bytes]

An alias for the type of byte sequences.

t [Buffer]

The abstract type of buffers.

tag [Format]

token [Genlex]

The type of tokens.

usage_msg [Arg]

window_id [GraphicsX11]

A
alarm [Gc]	An alarm is a piece of data that calls a user function at the end of each major GC cycle.
anon_fun [Arg]
B
backend_type [Sys]	Currently, the official distribution only supports `Native` and `Bytecode`, but it can be other backends with alternative compilers, for example, javascript.
backtrace_slot [Printexc]	The abstract type `backtrace_slot` represents a single slot of a backtrace.
C
channel [Event]	The type of communication channels carrying values of type `'a`.
color [Graphics]	A color is specified by its R, G, B components.
control [Gc]	The GC parameters are given as a `control` record.
D
data [Weak.S]	The type of the elements stored in the table.
doc [Arg]
E
elt [Set.S]	The type of the set elements.
elt [MoreLabels.Set.S]
equal [Ephemeron.GenHashTable]
error [Dynlink]
event [Graphics]	To specify events to wait for.
event [Event]	The type of communication events returning a result of type `'a`.
extern_flags [Marshal]	The flags to the `Marshal.to_*` functions below.
F
file_name [Scanf.Scanning]	A convenient alias to designate a file name.
format [Pervasives]
format4 [Pervasives]
format6 [Pervasives]
formatter [Format]	Abstract data corresponding to a pretty-printer (also called a formatter) and all its machinery.
formatter_out_functions [Format]	The set of output functions specific to a formatter: the `out_string` function performs all the pretty-printer string output. It is called with a string `s`, a start position `p`, and a number of characters `n`; it is supposed to output characters `p` to `p + n - 1` of `s`., the `out_flush` function flushes the pretty-printer output device., `out_newline` is called to open a new line when the pretty-printer splits the line., the `out_spaces` function outputs spaces when a break hint leads to spaces instead of a line split. It is called with the number of spaces to output., the `out_indent` function performs new line indentation when the pretty-printer splits the line. It is called with the indentation value of the new line. By default: fields `out_string` and `out_flush` are output device specific; (e.g. `Pervasives.output_string` and `Pervasives.flush` for a `Pervasives.out_channel` device, or `Buffer.add_substring` and `Pervasives.ignore` for a `Buffer.t` output device),, field `out_newline` is equivalent to `out_string "\n" 0 1`;, fields `out_spaces` and `out_indent` are equivalent to `out_string (String.make n ' ') 0 n`.
formatter_tag_functions [Format]	The semantic tag handling functions specific to a formatter: `mark` versions are the 'tag-marking' functions that associate a string marker to a tag in order for the pretty-printing engine to write those markers as 0 length tokens in the output device of the formatter.
fpclass [Pervasives]	The five classes of floating-point numbers, as determined by the `Pervasives.classify_float` function.
I
image [Graphics]	The abstract type for images, in internal representation.
in_channel [Scanf.Scanning]	The notion of input channel for the `Scanf` module: those channels provide all the machinery necessary to read from any source of characters, including a `Pervasives.in_channel` value.
in_channel [Pervasives]	The type of input channel.
K
key [MoreLabels.Map.S]
key [MoreLabels.Hashtbl.SeededS]
key [MoreLabels.Hashtbl.S]
key [Map.S]	The type of the map keys.
key [Hashtbl.SeededS]
key [Hashtbl.S]
key [Arg]
L
lexbuf [Lexing]	The type of lexer buffers.
linking_error [Dynlink]
location [Printexc]	The type of location information found in backtraces.
O
obj_t [Obj.Ephemeron]	alias for `Obj.t`
open_flag [Pervasives]	Opening modes for `Pervasives.open_out_gen` and `Pervasives.open_in_gen`.
out_channel [Pervasives]	The type of output channel.
P
position [Lexing]	A value of type `position` describes a point in a source file.
R
raw_backtrace [Printexc]	The abstract type `raw_backtrace` stores a backtrace in a low-level format, instead of directly exposing them as string as the `get_backtrace()` function does.
raw_backtrace_slot [Printexc]	This type allows direct access to raw backtrace slots, without any conversion in an OCaml-usable data-structure.
ref [Pervasives]	The type of references (mutable indirection cells) containing a value of type `'a`.
regexp [Str]	The type of compiled regular expressions.
result [Pervasives]
S
scanbuf [Scanf.Scanning]	The type of scanning buffers.
scanner [Scanf]	The type of formatted input scanners: `('a, 'b, 'c, 'd) scanner` is the type of a formatted input function that reads from some formatted input channel according to some format string; more precisely, if `scan` is some formatted input function, then `scan ic fmt f` applies `f` to all the arguments specified by format string `fmt`, when `scan` has read those arguments from the `Scanf.Scanning.in_channel` formatted input channel `ic`.
signal_behavior [Sys]	What to do when receiving a signal: `Signal_default`: take the default behavior (usually: abort the program), `Signal_ignore`: ignore the signal, `Signal_handle f`: call function `f`, giving it the signal number as argument.
spec [Arg]	The concrete type describing the behavior associated with a keyword.
split_result [Str]
stat [Gc]	The memory management counters are returned in a `stat` record.
statistics [MoreLabels.Hashtbl]
statistics [Hashtbl]
status [Graphics]	To report events.
symbolic_output_buffer [Format]	The output buffer of a symbolic pretty-printer.
symbolic_output_item [Format]	Items produced by symbolic pretty-printers
T
t [Weak.S]	The type of tables that contain elements of type `data`.
t [Weak]	The type of arrays of weak pointers (weak arrays).
t [Uchar]	The type for Unicode characters.
t [StringLabels]	An alias for the type of strings.
t [String]	An alias for the type of strings.
t [Stream]	The type of streams holding values of type `'a`.
t [Stack]	The type of stacks containing elements of type `'a`.
t [Spacetime.Series]	Type representing a file that will hold a series of heap snapshots together with additional information required to interpret those snapshots.
t [Set.OrderedType]	The type of the set elements.
t [Set.S]	The type of sets.
t [Random.State]	The type of PRNG states.
t [Queue]	The type of queues containing elements of type `'a`.
t [Printexc.Slot]
t [Obj.Ephemeron]	an ephemeron cf `Ephemeron`
t [Obj]
t [Nativeint]	An alias for the type of native integers.
t [Mutex]	The type of mutexes.
t [MoreLabels.Set.S]
t [MoreLabels.Map.S]
t [MoreLabels.Hashtbl.SeededS]
t [MoreLabels.Hashtbl.S]
t [MoreLabels.Hashtbl]
t [Map.OrderedType]	The type of the map keys.
t [Map.S]	The type of maps from type `key` to type `'a`.
t [Lazy]	A value of type `'a Lazy.t` is a deferred computation, called a suspension, that has a result of type `'a`.
t [Int64]	An alias for the type of 64-bit integers.
t [Int32]	An alias for the type of 32-bit integers.
t [Hashtbl.SeededHashedType]	The type of the hashtable keys.
t [Hashtbl.HashedType]	The type of the hashtable keys.
t [Hashtbl.SeededS]
t [Hashtbl.S]
t [Hashtbl]	The type of hash tables from type `'a` to type `'b`.
t [Ephemeron.Kn]	an ephemeron with an arbitrary number of keys of the same type
t [Ephemeron.K2]	an ephemeron with two keys
t [Ephemeron.K1]	an ephemeron with one key
t [Digest]	The type of digests: 16-character strings.
t [Complex]	The type of complex numbers.
t [Char]	An alias for the type of characters.
t [BytesLabels]	An alias for the type of byte sequences.
t [Bytes]	An alias for the type of byte sequences.
t [Buffer]	The abstract type of buffers.
tag [Format]
token [Genlex]	The type of tokens.
U
usage_msg [Arg]
W
window_id [GraphicsX11]