Index of values

!^s is a short-hand for string s.

x ^//^ y is a short-hand for prefix 2 1 x y.

x ^/^ y separates x and y with a breakable space.

doc1 ^^ doc2 is the concatenation of the documents doc1 and doc2.

align doc increases the indentation level to reach the current column.

arbitrary_string s is equivalent to separate (break 1) (lines s).

array f xs is a representation of the array xs, where the representation of each element is computed by the function f.

blank n is a document that consists of n blank characters.

bool b is a representation of the Boolenan value b.

break n is a document which consists of either n blank characters, when forced to display on a single line, or a single newline character, otherwise.

char c is a representation of the character c.

char c is a document that consists of the single character c.

column f is the document obtained by applying the function f to the current column number.

compact channel document prints the document document to the output channel channel.

concat docs is the concatenation of the documents in the list docs.

concat_map f xs is equivalent to concat (List.map f xs).

empty is the empty document.

enclose l r x is l ^^ x ^^ r.

fancystring s apparent_length is a document that consists of the string s.

fancysubstring s ofs len apparent_length is a document that consists of the portion of the string s delimited by the offset ofs and the length len.

float f is a representation of the floating-point number f.

flow sep docs separates the documents in the list docs with the separator sep and arranges for a new line to begin whenever a document does not fit on the current line.

flow_map sep f docs is equivalent to flow sep (List.map f docs).

group doc encodes a choice.

hardline is a forced newline document.

ifflat doc1 doc2 is rendered as doc1 if part of a group that can be successfully flattened, and is rendered as doc2 otherwise.

infix n b middle left right has the following flat layout:

left middle right

and the following non-flat layout:

left middle
  right

The parameter n controls the nesting of right (when not flat).

int i is a representation of the integer i.

int32 i is a representation of the 32-bit integer i.

int64 i is a representation of the 64-bit integer i.

jump n b right is equivalent to prefix n b empty right.

lines s is the list of documents obtained by splitting s at newline characters, and turning each line into a document via substring.

list f xs is a representation of the list xs, where the representation of each element is computed by the function f.

nativeint i is a representation of the native integer i.

nest j doc is the document doc, in which the indentation level has been increased by j, that is, in which j blanks have been inserted after every newline character.

nesting f is the document obtained by applying the function f to the current indentation level, that is, the number of indentation (blank) characters that were inserted at the beginning of the current line.

option f o is a representation of the option o, where the representation of the element, if present, is computed by the function f.

optional f None is the empty document.

precede l x is l ^^ x.

prefix n b left right has the following flat layout:

left right

and the following non-flat layout:

left
  right

The parameter n controls the nesting of right (when not flat).

pretty rfrac width channel document pretty-prints the document document into the output channel channel.

record _ fields is a description of a record value whose fields are fields.

ref r is a representation of the reference r, where the representation of the content is computed by the function f.

repeat n doc is the document obtained by concatenating n copies of the document doc.

separate sep docs is the concatenation of the documents in the list docs.

separate2 sep last_sep docs is the concatenation of the documents in the list docs.

separate_map sep f xs is equivalent to separate sep (List.map f xs).

soft_surround is analogous to surround, but involves more than one group, so it offers possibilities other than the completely flat layout (where opening, contents, and closing appear on a single line) and the completely developed layout (where opening, contents, and closing appear on separate lines).

split ok s splits the string s before and after every occurrence of a character that satisfies the predicate ok.

string s is a representation of the string s.

string s is a document that consists of the string s.

substring s ofs len is a document that consists of the portion of the string s delimited by the offset ofs and the length len.

surround n b opening contents closing has the following flat layout:

opening contents closing

and the following non-flat layout:

opening
  contents
closing

The parameter n controls the nesting of contents (when not flat).

surround_separate n b void opening sep closing docs is equivalent to surround n b opening (separate sep docs) closing, except when the list docs is empty, in which case it reduces to void.

surround_separate_map n b void opening sep closing f xs is equivalent to surround_separate n b void opening sep closing (List.map f xs).

terminate r x is x ^^ r.

tuple args is a description of a tuple value whose components are args.

twice doc is the document obtained by concatenating two copies of the document doc.

unknown t _ is a representation of an unknown value of type t.

url s is a possible way of displaying the URL s.

utf8string s is a document that consists of the UTF-8-encoded string s.

variant _ dc _ args is a description of a constructed value whose data constructor is dc and whose arguments are args.

words s is the list of documents obtained by splitting s at whitespace characters, and turning each word into a document via substring.