Index of values


(!^) [PPrintCombinators]
!^s is a short-hand for string s.
(^//^) [PPrintCombinators]
x ^//^ y is a short-hand for prefix 2 1 x y.
(^/^) [PPrintCombinators]
x ^/^ y separates x and y with a breakable space.
(^^) [PPrintEngine]
doc1 ^^ doc2 is the concatenation of the documents doc1 and doc2.

A
align [PPrintEngine]
align doc is the document doc, in which the indentation level has been set to the current column.
ampersand [PPrintCombinators]
angles [PPrintCombinators]
arbitrary_string [PPrintCombinators]
arbitrary_string s is equivalent to separate (break 1) (lines s).
array [PPrintOCaml]
array f xs is a representation of the array xs, where the representation of each element is computed by the function f.
at [PPrintCombinators]

B
backslash [PPrintCombinators]
bang [PPrintCombinators]
bar [PPrintCombinators]
blank [PPrintEngine]
blank n is a document that consists of n blank characters.
bool [PPrintOCaml]
bool b is a representation of the Boolenan value b.
bquote [PPrintCombinators]
bquotes [PPrintCombinators]
braces [PPrintCombinators]
brackets [PPrintCombinators]
break [PPrintEngine]
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.

C
caret [PPrintCombinators]
char [PPrintOCaml]
char c is a representation of the character c.
char [PPrintEngine]
char c is a document that consists of the single character c.
colon [PPrintCombinators]
comma [PPrintCombinators]
compact [PPrintEngine]
compact output doc prints the document doc.
compact [PPrintRenderer.RENDERER]
compact channel document prints the document document to the output channel channel.
concat [PPrintCombinators]
concat docs is the concatenation of the documents in the list docs.
concat_map [PPrintCombinators]
concat_map f xs is equivalent to concat (List.map f xs).
custom [PPrintEngine]
The function custom constructs a custom document.

D
dollar [PPrintCombinators]
dot [PPrintCombinators]
dquote [PPrintCombinators]
dquotes [PPrintCombinators]

E
empty [PPrintEngine]
empty is the empty document.
enclose [PPrintCombinators]
enclose l r x is l ^^ x ^^ r.
equals [PPrintCombinators]

F
fancystring [PPrintEngine]
fancystring s apparent_length is a document that consists of the string s.
fancysubstring [PPrintEngine]
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 [PPrintOCaml]
float f is a representation of the floating-point number f.
flow [PPrintCombinators]
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 [PPrintCombinators]
flow_map sep f docs is equivalent to flow sep (List.map f docs).

G
group [PPrintEngine]
group doc encodes a choice.

H
hang [PPrintCombinators]
hardline [PPrintEngine]
hardline is a forced newline document.

I
ifflat [PPrintEngine]
ifflat doc1 doc2 is rendered as doc1 if part of a group that can be successfully flattened, and is rendered as doc2 otherwise.
infinity [PPrintEngine]
infix [PPrintCombinators]
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 [PPrintOCaml]
int i is a representation of the integer i.
int32 [PPrintOCaml]
int32 i is a representation of the 32-bit integer i.
int64 [PPrintOCaml]
int64 i is a representation of the 64-bit integer i.

J
jump [PPrintCombinators]
jump n b right is equivalent to prefix n b empty right.

L
langle [PPrintCombinators]
lbrace [PPrintCombinators]
lbracket [PPrintCombinators]
lines [PPrintCombinators]
lines s is the list of documents obtained by splitting s at newline characters, and turning each line into a document via substring.
list [PPrintOCaml]
list f xs is a representation of the list xs, where the representation of each element is computed by the function f.
lparen [PPrintCombinators]

M
minus [PPrintCombinators]

N
nativeint [PPrintOCaml]
nativeint i is a representation of the native integer i.
nest [PPrintEngine]
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.

O
option [PPrintOCaml]
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 [PPrintCombinators]
optional f None is the empty document.

P
parens [PPrintCombinators]
percent [PPrintCombinators]
plus [PPrintCombinators]
precede [PPrintCombinators]
precede l x is l ^^ x.
prefix [PPrintCombinators]
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 [PPrintEngine]
pretty output state indent flatten doc prints the document doc.
pretty [PPrintRenderer.RENDERER]
pretty rfrac width channel document pretty-prints the document document into the output channel channel.

Q
qmark [PPrintCombinators]

R
rangle [PPrintCombinators]
rbrace [PPrintCombinators]
rbracket [PPrintCombinators]
record [PPrintOCaml]
record _ fields is a description of a record value whose fields are fields.
ref [PPrintOCaml]
ref r is a representation of the reference r, where the representation of the content is computed by the function f.
repeat [PPrintCombinators]
repeat n doc is the document obtained by concatenating n copies of the document doc.
requirement [PPrintEngine]
requirement doc computes the width requirement of the document doc.
rparen [PPrintCombinators]

S
semi [PPrintCombinators]
separate [PPrintCombinators]
separate sep docs is the concatenation of the documents in the list docs.
separate2 [PPrintCombinators]
separate2 sep last_sep docs is the concatenation of the documents in the list docs.
separate_map [PPrintCombinators]
separate_map sep f xs is equivalent to separate sep (List.map f xs).
sharp [PPrintCombinators]
slash [PPrintCombinators]
soft_surround [PPrintCombinators]
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).
space [PPrintCombinators]
split [PPrintCombinators]
split ok s splits the string s before and after every occurrence of a character that satisfies the predicate ok.
squote [PPrintCombinators]
squotes [PPrintCombinators]
star [PPrintCombinators]
string [PPrintOCaml]
string s is a representation of the string s.
string [PPrintEngine]
string s is a document that consists of the string s.
substring [PPrintEngine]
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 [PPrintCombinators]
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 [PPrintCombinators]
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 [PPrintCombinators]
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).

T
terminate [PPrintCombinators]
terminate r x is x ^^ r.
tilde [PPrintCombinators]
tuple [PPrintOCaml]
tuple args is a description of a tuple value whose components are args.
twice [PPrintCombinators]
twice doc is the document obtained by concatenating two copies of the document doc.

U
underscore [PPrintCombinators]
unknown [PPrintOCaml]
unknown t _ is a representation of an unknown value of type t.
url [PPrintCombinators]
url s is a possible way of displaying the URL s.
utf8string [PPrintEngine]
utf8string s is a document that consists of the UTF-8-encoded string s.

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

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