Index of values


A
always [Fmt]
always fmt ppf v formats any value with the constant format fmt.
append [Fmt]
append pp_v0 pp_v1 ppf (v0, v1) is pp_v0 ppf v0; pp_v1 ppf v1.
array [Fmt.Dump]
array pp_v formats an OCaml array using pp_v for the array elements.
array [Fmt]
array sep pp_v formats array elements.

B
bi_byte_size [Fmt]
bi_byte_size formats a byte size according to its magnitude using binary prefixes up to pebi bytes (215).
bool [Fmt]
bool is Format.pp_print_bool.
box [Fmt]
box ~indent pp ppf wraps pp in a horizontal or vertical box.
braces [Fmt]
braces pp_v ppf is pf "@[<1>{%a}@]" pp_v.
brackets [Fmt]
brackets pp_v ppf is pf "@[<1>[%a]@]" pp_v.
buffer [Fmt]
buffer formats a Buffer.t value's current contents.
byte_size [Fmt]
byte_size formats a byte size according to its magnitude using SI prefixes up to peta bytes (1015).

C
char [Fmt]
char is Format.pp_print_char.
const [Fmt]
const pp_v v always formats v using pp_v.
cut [Fmt]
cut is Format.pp_print_cut.

E
epr [Fmt]
epr is pf stderr.
exn [Fmt]
exn formats an exception.
exn_backtrace [Fmt]
exn_backtrace formats an exception backtrace.

F
float [Fmt]
float ppf is pf ppf "%g".
float_dfrac [Fmt]
float_dfrac d rounds the float to the dth decimal fractional digit and formats the result with "%g".
float_dsig [Fmt]
float_dsig d rounds the normalized decimal significand of the float to the dth decimal fractional digit and formats the result with "%g".
fmt [Fmt]
fmt fmt ppf is pf ppf fmt.

H
hashtbl [Fmt.Dump]
hashtbl pp_k pp_v formats an unspecified representation of the bindings of a hash table using pp_k for the keys and pp_v for the values.
hashtbl [Fmt]
hashtbl ~sep pp_binding formats the bindings of a hash table.
hbox [Fmt]
hbox is like Fmt.box but is a horizontal box: the line is not split in this box (but may be in sub-boxes).
hvbox [Fmt]
hvbox is like Fmt.box but is either Fmt.hbox if its fits on a single line or Fmt.vbox otherwise.

I
if_utf_8 [Fmt]
if_utf_8 pp_u pp ppf v is: pp_u ppf v if utf_8 ppf is true., pp ppf v otherwise.
int [Fmt]
int is pf ppf "%d".
int32 [Fmt]
int32 ppf is pf ppf "%ld".
int64 [Fmt]
int64 ppf is pf ppf "%Ld".
iter [Fmt.Dump]
iter iter pp_name pp_elt formats an unspecified representation of the iterations of iter over a value using pp_elt.
iter [Fmt]
iter ~sep iter pp_elt formats the iterations of iter over a value using pp_elt.
iter_bindings [Fmt.Dump]
iter_bindings ~sep iter pp_name pp_k pp_v formats an unspecified representation of the iterations of iter over a value using pp_k and pp_v.
iter_bindings [Fmt]
iter_bindings ~sep iter pp_binding formats the iterations of iter over a value using pp_binding.

K
kpf [Fmt]
kpf is Format.kfprintf.
kstrf [Fmt]
kstrf is like Fmt.strf but continuation based.

L
lines [Fmt]
lines formats lines by replacing newlines ('\n') in the string with calls to Format.pp_force_newline.
list [Fmt.Dump]
list pp_v formats an OCaml list using pp_v for the list elements.
list [Fmt]
list sep pp_v formats list elements.

N
nativeint [Fmt]
nativeint ppf is pf ppf "%nd".
nop [Fmt]
nop formats nothing.

O
of_to_string [Fmt]
of_to_string f ppf v is string ppf (f v).
option [Fmt.Dump]
option pp_v formats an OCaml option using pp_v for the Some case.
option [Fmt]
option ~none pp_v formats an optional value.

P
pair [Fmt.Dump]
pair pp_fst pp_snd formats an OCaml pair using pp_fst and pp_snd for the first and second projection.
pair [Fmt]
pair ~sep pp_fst pp_snd formats a pair.
paragraphs [Fmt]
paragraphs formats paragraphs by suppressing initial and trailing spaces and newlines, replacing blank lines (a line made only of white space) by a two Format.pp_force_newline and remaining consecutive white space with a single Format.pp_print_space.
parens [Fmt]
parens pp_v ppf is pf "@[<1>(%a)@]" pp_v.
pf [Fmt]
pf is Format.fprintf.
pr [Fmt]
pr is pf stdout.
prefix [Fmt]
prefix pp_pre pp prefixes pp by pp_pre.

Q
queue [Fmt.Dump]
queue pp_v formats an unspecified representation of an OCaml queue using pp_v to format its elements, in least recently added order.
queue [Fmt]
queue ~sep pp_v formats queue elements.
quote [Fmt]
quote ~mark pp_v ppf is pf "@[<1>@<1>%s%a@<1>%s@]" mark pp_v mark, mark defaults to "\"", it is always counted as spanning as single column (this allows for UTF-8 encoded marks).

R
result [Fmt.Dump]
result ~ok ~error formats an OCaml result using ok for the Ok case value and error for the Error case value.
result [Fmt]
result ~ok ~error formats a result value using ok for the Ok case and error for the Error case.

S
set_style_renderer [Fmt]
set_style_renderer ppf r sets the style renderer of ppf to r.
set_utf_8 [Fmt]
set_utf_8 ppf b enables or disables conditional UTF-8 formatting on ppf.
setup [Fmt_tty]
setup ?style_renderer ?utf_8 outc is a formatter for outc with Fmt.set_style_renderer and Fmt.set_utf_8 correctly setup.
setup_std_outputs [Fmt_tty]
setup_std_outputs ?style_renderer ?utf_8 () applies Fmt_tty.setup on stdout and stderr.
signal [Fmt.Dump]
signal formats an OCaml signal number as a C POSIX constant or "SIG(%d)" the signal number is unknown.
sp [Fmt]
sp is Format.pp_print_space.
stack [Fmt.Dump]
stack pp_v formats an unspecified representation of an OCaml stack using pp_v to format its elements in top to bottom order.
stack [Fmt]
stack ~sep pp_v formats stack elements.
stderr [Fmt]
stderr is the standard error formatter.
stdout [Fmt]
stdout is the standard output formatter.
strf [Fmt]
strf is Format.asprintf.
strf_like [Fmt]
strf_like ppf is like Fmt.strf except its Fmt.utf_8 and Fmt.style_renderer settings are those of ppf.
string [Fmt]
string is Format.pp_print_string.
style_renderer [Fmt_cli]
style_renderer ?env ?docs () is a Cmdliner option --color that can be directly used with the optional arguments of TTY setup or to control style rendering.
style_renderer [Fmt]
style_renderer ppf is the style renderer used by ppf.
styled [Fmt]
styled s pp formats like pp but styled with s.
styled_unit [Fmt]
styled_unit s fmt is style s (unit fmt).
suffix [Fmt]
suffix pp_suf pp suffixes pp by pp_suf.

T
text [Fmt]
text formats text by respectively replacing spaces and newlines in the string with Format.pp_print_space and Format.pp_force_newline.
text_loc [Fmt]
text_loc formats a line-column text range according to GNU conventions.
to_to_string [Fmt]
to_to_string pp_v v is strf "%a" pp_v v.

U
uint [Fmt]
uint ppf is pf ppf "%u".
uint32 [Fmt]
uint32 ppf is pf ppf "%lu".
uint64 [Fmt]
uint64 ppf is pf ppf "%Lu".
unativeint [Fmt]
unativeint ppf is pf ppf "%nu".
unit [Fmt]
unit fmt formats a unit value with the format fmt.
using [Fmt]
using f pp maps values using f and formats them with pp.
utf_8 [Fmt]
utf_8 ppf is true if UTF-8 output is enabled on ppf.

V
vbox [Fmt]
vbox is like Fmt.box but is a vertical box: every break hint leads to a new line which adds indent to the current indentation (default to 0).

W
with_buffer [Fmt]
with_buffer ~like b is a formatter whose Fmt.utf_8 and Fmt.style_renderer settings are copied from those of like (if provided).
words [Fmt]
words formats words by suppressing initial and trailing white space and replacing consecutive white space with a single Format.pp_print_space.