Index of values

( ++ ) is Fmt.append.

addresses pp formats sequences by applying pp to consecutive subsequences of length w (defaults to 16).

any fmt ppf v formats any value with the constant format fmt.

append pp_v0 pp_v1 ppf v is pp_v0 ppf v; pp_v1 ppf v.

array pp_v formats an OCaml array using pp_v for the array elements.

array sep pp_v formats array elements.

ascii ~w ~subst () formats character sequences by printing characters in the printable US-ASCII range ([0x20];[0x7E]) as is, and replacing the rest with subst (defaults to fmt ".").

bi_byte_size formats a byte size according to its magnitude using binary prefixes up to pebi bytes (2¹⁵).

bool is Format.pp_print_bool.

box ~indent pp ppf wraps pp in a pretty-printing box.

braces pp_v ppf is pf "@[<1>{%a}@]" pp_v.

brackets pp_v ppf is pf "@[<1>[%a]@]" pp_v.

buffer formats a Buffer.t value's current contents.

byte_size is si_size ~scale:0 "B".

char is Format.pp_print_char.

comma is Fmt.any ",@ ".

concat ~sep pps formats a value using the formaters pps and separting each format with sep (defaults to Fmt.cut).

const pp_v v always formats v using pp_v.

cut has the effect of Format.pp_print_cut.

did_you_mean ~pre kind ~post pp_v formats a faulty value v of kind kind and a list of hints that v could have been mistaken for.

epr is pf stderr.

error fmt ... is kstr (fun s -> Error s) fmt ...

error_msg fmt ... is kstr (fun s -> Error (`Msg s)) fmt ...

exn formats an exception.

exn_backtrace formats an exception backtrace.

failwith is kstr failwith, raises Stdlib.Failure with a pretty-printed string argument.

failwith_notrace is like Fmt.failwith but raises with raise_notrace.

field ~label l prj pp_v pretty prints a named field using label (defaults to styled `Yellow string) for the label, and using prj pp_v for the field value.

field ~label ~sep l prj pp_v pretty prints a labelled field value as pf "@[<1>%a%a%a@]" label l sep () (using prj pp_v).

float ppf is pf ppf "%g".

float_dfrac d rounds the float to the dth decimal fractional digit and formats the result with "%g".

float_dsig d rounds the normalized decimal significand of the float to the dth decimal fractional digit and formats the result with "%g".

flush has the effect of Format.pp_print_flush

fmt fmt ppf is pf ppf fmt.

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 ~sep pp_binding formats the bindings of a hash table.

hbox is like Fmt.box but is a horizontal box: the line is not split in this box (but may be in sub-boxes).

hex ~w () formats character sequences as traditional hex dumps, matching the output of xxd and forcing line breaks after every w characters (defaults to 16).

hovbox is a condensed Fmt.box.

hvbox is like Fmt.hbox if it fits on a single line, or like Fmt.vbox otherwise.

id is Fun.id.

if_utf_8 pp_u pp ppf v is: pp_u ppf v if utf_8 ppf is true., pp ppf v otherwise.

int ppf is pf ppf "%d".

int32 ppf is pf ppf "%ld".

int64 ppf is pf ppf "%Ld".

invalid_arg is kstr invalid_arg, raises Stdlib.Invalid_argument with a pretty-printed string argument.

iter iter pp_name pp_elt formats an unspecified representation of the iterations of iter over a value using pp_elt.

iter ~sep iter pp_elt formats the iterations of iter over a value using pp_elt.

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 ~sep iter pp_binding formats the iterations of iter over a value using pp_binding.

kpf is Format.kfprintf.

kstr is like Fmt.str but continuation based.

lines formats lines by replacing newlines ('\n') in the string with calls to Format.pp_force_newline.

list pp_v formats an OCaml list using pp_v for the list elements.

list sep pp_v formats list elements.

nativeint ppf is pf ppf "%nd".

nop formats nothing.

octets ~w ~sep () formats character sequences as hexadecimal digits.

of_to_string f ppf v is string ppf (f v).

on_bytes pp is pp adapted to format (entire) bytes.

on_string pp is pp adapted to format (entire) strings.

one_of ~empty pp_v ppf l formats according to the length of l 0, formats empty (defaults to Fmt.nop)., 1, formats the element with pp_v., 2, formats "either %a or %a" with the list elements, n, formats "one of %a, ... or %a" with the list elements

option pp_v formats an OCaml option using pp_v for the Some case.

option ~none pp_v formats an optional value.

pair pp_fst pp_snd formats an OCaml pair using pp_fst and pp_snd for the first and second projection.

pair ~sep pp_fst pp_snd formats a pair.

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 pp_v ppf is pf "@[<1>(%a)@]" pp_v.

pf is Format.fprintf.

pr is pf stdout.

queue pp_v formats an unspecified representation of an OCaml queue using pp_v to format its elements, in least recently added order.

queue ~sep pp_v formats queue elements.

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).

record fields pretty-prints a value using the concatenation of fields, separated by ";@,", framed in a vertical box and surrounded by Fmt.braces.

record ~sep fields pretty-prints a value using the concatenation of fields, separated by sep (defaults to cut) and framed in a vertical box.

result ~ok ~error formats an OCaml result using ok for the Ok case value and error for the Error case value.

result ~ok ~error formats a result value using ok for the Ok case and error for the Error case.

semi is Fmt.any ";@ ".

seq pp_v formats an OCaml sequence using pp_v for the sequence elements.

seq sep pp_v formats sequence elements.

set_style_renderer ppf r sets the style renderer of ppf to r.

set_utf_8 ppf b enables or disables conditional UTF-8 formatting on ppf.

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 ?style_renderer ?utf_8 () applies Fmt_tty.setup on stdout and stderr.

si_size ~scale unit formats a non negative integer representing unit unit at scale 10^{scale * 3}, depending on its magnitude, using power of 3 SI prefixes (i.e.

signal formats an OCaml signal number as a C POSIX constant or "SIG(%d)" the signal number is unknown.

sp has the effect of Format.pp_print_space.

sps n has the effect of Format.pp_print_break n 0.

stack pp_v formats an unspecified representation of an OCaml stack using pp_v to format its elements in top to bottom order.

stack ~sep pp_v formats stack elements.

stderr is the standard error formatter.

stdout is the standard output formatter.

str is Format.asprintf.

str_like ppf is like Fmt.str except its Fmt.utf_8 and val-style_renderer settings are those of ppf.

string is pf ppf "%S".

string is Format.pp_print_string.

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 ppf is the style renderer used by ppf.

styled s pp formats like pp but styled with s.

text formats text by respectively replacing spaces and newlines in the string with Format.pp_print_space and Format.pp_force_newline.

text_loc formats a line-column text range according to GNU conventions.

to_to_string pp_v v is strf "%a" pp_v v.

truncated ~max formats a string using at most max characters.

uchar formats an OCaml Uchar.t value using only US-ASCII encoded characters according to the Unicode notational convention for code points.

uint ppf is pf ppf "%u".

uint32 ppf is pf ppf "%lu".

uint64 ppf is pf ppf "%Lu".

uint64_ns_span formats an unsigned nanosecond time span according to its magnitude using SI prefixes on seconds and accepted non-SI units.

unativeint ppf is pf ppf "%nu".

using f pp ppf v ppf ppf (f v).

utf_8 ppf is true if UTF-8 output is enabled on ppf.

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 (defaults to 0).

with_buffer ~like b is a formatter whose Fmt.utf_8 and val-style_renderer settings are copied from those of like (if provided).

words formats words by suppressing initial and trailing white space and replacing consecutive white space with a single Format.pp_print_space.