mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
159 lines
No EOL
118 KiB
HTML
159 lines
No EOL
118 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCFormat (containers.CCFormat)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCFormat</nav><header class="odoc-preamble"><h1>Module <code><span>CCFormat</span></code></h1><p>Helpers for Format</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></header><nav class="odoc-toc"><ul><li><a href="#combinators">Combinators</a></li><li><a href="#ansi-codes">ANSI codes</a></li><li><a href="#io">IO</a></li><li><a href="#dump">Dump</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a iter</span></span><span> = <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-include"><div class="spec-doc"><p><a href="https://caml.inria.fr/pub/docs/manual-ocaml/libref/Format.html">Documentation for the standard Format module</a></p></div><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <span class="xref-unresolved">Stdlib</span>.Format <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec type anchored" id="type-formatter"><a href="#type-formatter" class="anchor"></a><code><span><span class="keyword">type</span> formatter</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.formatter</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_box"><a href="#val-pp_open_box" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_box : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_box"><a href="#val-open_box" class="anchor"></a><code><span><span class="keyword">val</span> open_box : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_close_box"><a href="#val-pp_close_box" class="anchor"></a><code><span><span class="keyword">val</span> pp_close_box : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close_box"><a href="#val-close_box" class="anchor"></a><code><span><span class="keyword">val</span> close_box : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_hbox"><a href="#val-pp_open_hbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_hbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_hbox"><a href="#val-open_hbox" class="anchor"></a><code><span><span class="keyword">val</span> open_hbox : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_vbox"><a href="#val-pp_open_vbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_vbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_vbox"><a href="#val-open_vbox" class="anchor"></a><code><span><span class="keyword">val</span> open_vbox : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_hvbox"><a href="#val-pp_open_hvbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_hvbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_hvbox"><a href="#val-open_hvbox" class="anchor"></a><code><span><span class="keyword">val</span> open_hvbox : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_hovbox"><a href="#val-pp_open_hovbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_hovbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_hovbox"><a href="#val-open_hovbox" class="anchor"></a><code><span><span class="keyword">val</span> open_hovbox : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_string"><a href="#val-pp_print_string" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_string : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_string"><a href="#val-print_string" class="anchor"></a><code><span><span class="keyword">val</span> print_string : <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_bytes"><a href="#val-pp_print_bytes" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_bytes : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_bytes"><a href="#val-print_bytes" class="anchor"></a><code><span><span class="keyword">val</span> print_bytes : <span>bytes <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_as"><a href="#val-pp_print_as" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_as : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_as"><a href="#val-print_as" class="anchor"></a><code><span><span class="keyword">val</span> print_as : <span>int <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_int"><a href="#val-pp_print_int" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_int : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_int"><a href="#val-print_int" class="anchor"></a><code><span><span class="keyword">val</span> print_int : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_float"><a href="#val-pp_print_float" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_float : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_float"><a href="#val-print_float" class="anchor"></a><code><span><span class="keyword">val</span> print_float : <span>float <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_char"><a href="#val-pp_print_char" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_char : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>char <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_char"><a href="#val-print_char" class="anchor"></a><code><span><span class="keyword">val</span> print_char : <span>char <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_bool"><a href="#val-pp_print_bool" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_bool : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_bool"><a href="#val-print_bool" class="anchor"></a><code><span><span class="keyword">val</span> print_bool : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_space"><a href="#val-pp_print_space" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_space : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_space"><a href="#val-print_space" class="anchor"></a><code><span><span class="keyword">val</span> print_space : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_cut"><a href="#val-pp_print_cut" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_cut : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_cut"><a href="#val-print_cut" class="anchor"></a><code><span><span class="keyword">val</span> print_cut : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_break"><a href="#val-pp_print_break" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_break : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_break"><a href="#val-print_break" class="anchor"></a><code><span><span class="keyword">val</span> print_break : <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_custom_break"><a href="#val-pp_print_custom_break" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_custom_break :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>fits:<span>(string * int * string)</span> <span class="arrow">-></span></span>
|
||
<span>breaks:<span>(string * int * string)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_force_newline"><a href="#val-pp_force_newline" class="anchor"></a><code><span><span class="keyword">val</span> pp_force_newline : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-force_newline"><a href="#val-force_newline" class="anchor"></a><code><span><span class="keyword">val</span> force_newline : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_if_newline"><a href="#val-pp_print_if_newline" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_if_newline : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_if_newline"><a href="#val-print_if_newline" class="anchor"></a><code><span><span class="keyword">val</span> print_if_newline : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_flush"><a href="#val-pp_print_flush" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_flush : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_flush"><a href="#val-print_flush" class="anchor"></a><code><span><span class="keyword">val</span> print_flush : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_newline"><a href="#val-pp_print_newline" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_newline : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_newline"><a href="#val-print_newline" class="anchor"></a><code><span><span class="keyword">val</span> print_newline : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_margin"><a href="#val-pp_set_margin" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_margin : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_margin"><a href="#val-set_margin" class="anchor"></a><code><span><span class="keyword">val</span> set_margin : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_margin"><a href="#val-pp_get_margin" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_margin : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_margin"><a href="#val-get_margin" class="anchor"></a><code><span><span class="keyword">val</span> get_margin : <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_max_indent"><a href="#val-pp_set_max_indent" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_max_indent : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_max_indent"><a href="#val-set_max_indent" class="anchor"></a><code><span><span class="keyword">val</span> set_max_indent : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_max_indent"><a href="#val-pp_get_max_indent" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_max_indent : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_max_indent"><a href="#val-get_max_indent" class="anchor"></a><code><span><span class="keyword">val</span> get_max_indent : <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-geometry"><a href="#type-geometry" class="anchor"></a><code><span><span class="keyword">type</span> geometry</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.geometry</span><span> = </span><span>{</span></code><ol><li id="type-geometry.max_indent" class="def record field anchored"><a href="#type-geometry.max_indent" class="anchor"></a><code><span>max_indent : int;</span></code></li><li id="type-geometry.margin" class="def record field anchored"><a href="#type-geometry.margin" class="anchor"></a><code><span>margin : int;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-check_geometry"><a href="#val-check_geometry" class="anchor"></a><code><span><span class="keyword">val</span> check_geometry : <span><a href="#type-geometry">geometry</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_geometry"><a href="#val-pp_set_geometry" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_geometry : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>max_indent:int <span class="arrow">-></span></span> <span>margin:int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_geometry"><a href="#val-set_geometry" class="anchor"></a><code><span><span class="keyword">val</span> set_geometry : <span>max_indent:int <span class="arrow">-></span></span> <span>margin:int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_safe_set_geometry"><a href="#val-pp_safe_set_geometry" class="anchor"></a><code><span><span class="keyword">val</span> pp_safe_set_geometry : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>max_indent:int <span class="arrow">-></span></span> <span>margin:int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-safe_set_geometry"><a href="#val-safe_set_geometry" class="anchor"></a><code><span><span class="keyword">val</span> safe_set_geometry : <span>max_indent:int <span class="arrow">-></span></span> <span>margin:int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_update_geometry"><a href="#val-pp_update_geometry" class="anchor"></a><code><span><span class="keyword">val</span> pp_update_geometry : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>(<span><a href="#type-geometry">geometry</a> <span class="arrow">-></span></span> <a href="#type-geometry">geometry</a>)</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_geometry"><a href="#val-update_geometry" class="anchor"></a><code><span><span class="keyword">val</span> update_geometry : <span><span>(<span><a href="#type-geometry">geometry</a> <span class="arrow">-></span></span> <a href="#type-geometry">geometry</a>)</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_geometry"><a href="#val-pp_get_geometry" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_geometry : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-geometry">geometry</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_geometry"><a href="#val-get_geometry" class="anchor"></a><code><span><span class="keyword">val</span> get_geometry : <span>unit <span class="arrow">-></span></span> <a href="#type-geometry">geometry</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_max_boxes"><a href="#val-pp_set_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_max_boxes : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_max_boxes"><a href="#val-set_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> set_max_boxes : <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_max_boxes"><a href="#val-pp_get_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_max_boxes : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_max_boxes"><a href="#val-get_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> get_max_boxes : <span>unit <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_over_max_boxes"><a href="#val-pp_over_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> pp_over_max_boxes : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-over_max_boxes"><a href="#val-over_max_boxes" class="anchor"></a><code><span><span class="keyword">val</span> over_max_boxes : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_tbox"><a href="#val-pp_open_tbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_tbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_tbox"><a href="#val-open_tbox" class="anchor"></a><code><span><span class="keyword">val</span> open_tbox : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_close_tbox"><a href="#val-pp_close_tbox" class="anchor"></a><code><span><span class="keyword">val</span> pp_close_tbox : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close_tbox"><a href="#val-close_tbox" class="anchor"></a><code><span><span class="keyword">val</span> close_tbox : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_tab"><a href="#val-pp_set_tab" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_tab : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_tab"><a href="#val-set_tab" class="anchor"></a><code><span><span class="keyword">val</span> set_tab : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_tab"><a href="#val-pp_print_tab" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_tab : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_tab"><a href="#val-print_tab" class="anchor"></a><code><span><span class="keyword">val</span> print_tab : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_tbreak"><a href="#val-pp_print_tbreak" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_tbreak : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_tbreak"><a href="#val-print_tbreak" class="anchor"></a><code><span><span class="keyword">val</span> print_tbreak : <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_ellipsis_text"><a href="#val-pp_set_ellipsis_text" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_ellipsis_text : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_ellipsis_text"><a href="#val-set_ellipsis_text" class="anchor"></a><code><span><span class="keyword">val</span> set_ellipsis_text : <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_ellipsis_text"><a href="#val-pp_get_ellipsis_text" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_ellipsis_text : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_ellipsis_text"><a href="#val-get_ellipsis_text" class="anchor"></a><code><span><span class="keyword">val</span> get_ellipsis_text : <span>unit <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-stag"><a href="#type-stag" class="anchor"></a><code><span><span class="keyword">type</span> stag</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.stag</span><span> = </span><span>..</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-tag"><a href="#type-tag" class="anchor"></a><code><span><span class="keyword">type</span> tag</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-String_tag"><a href="#extension-decl-String_tag" class="anchor"></a><code><span><span class="keyword">type</span> <a href="#type-stag">stag</a> += </span></code><ol><li id="extension-String_tag" class="def extension anchored"><a href="#extension-String_tag" class="anchor"></a><code><span>| </span><span><span class="extension">String_tag</span> <span class="keyword">of</span> <a href="#type-tag">tag</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_stag"><a href="#val-pp_open_stag" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_stag : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_stag"><a href="#val-open_stag" class="anchor"></a><code><span><span class="keyword">val</span> open_stag : <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_close_stag"><a href="#val-pp_close_stag" class="anchor"></a><code><span><span class="keyword">val</span> pp_close_stag : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close_stag"><a href="#val-close_stag" class="anchor"></a><code><span><span class="keyword">val</span> close_stag : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_tags"><a href="#val-pp_set_tags" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_tags : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_tags"><a href="#val-set_tags" class="anchor"></a><code><span><span class="keyword">val</span> set_tags : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_print_tags"><a href="#val-pp_set_print_tags" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_print_tags : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_print_tags"><a href="#val-set_print_tags" class="anchor"></a><code><span><span class="keyword">val</span> set_print_tags : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_mark_tags"><a href="#val-pp_set_mark_tags" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_mark_tags : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_mark_tags"><a href="#val-set_mark_tags" class="anchor"></a><code><span><span class="keyword">val</span> set_mark_tags : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_print_tags"><a href="#val-pp_get_print_tags" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_print_tags : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_print_tags"><a href="#val-get_print_tags" class="anchor"></a><code><span><span class="keyword">val</span> get_print_tags : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_mark_tags"><a href="#val-pp_get_mark_tags" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_mark_tags : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_mark_tags"><a href="#val-get_mark_tags" class="anchor"></a><code><span><span class="keyword">val</span> get_mark_tags : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_formatter_out_channel"><a href="#val-pp_set_formatter_out_channel" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_formatter_out_channel : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_formatter_out_channel"><a href="#val-set_formatter_out_channel" class="anchor"></a><code><span><span class="keyword">val</span> set_formatter_out_channel : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_formatter_output_functions"><a href="#val-pp_set_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_formatter_output_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_formatter_output_functions"><a href="#val-set_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> set_formatter_output_functions :
|
||
<span><span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_formatter_output_functions"><a href="#val-pp_get_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_formatter_output_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> * <span>(<span>unit <span class="arrow">-></span></span> unit)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_formatter_output_functions"><a href="#val-get_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> get_formatter_output_functions :
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> * <span>(<span>unit <span class="arrow">-></span></span> unit)</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-formatter_out_functions"><a href="#type-formatter_out_functions" class="anchor"></a><code><span><span class="keyword">type</span> formatter_out_functions</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.formatter_out_functions</span><span> = </span><span>{</span></code><ol><li id="type-formatter_out_functions.out_string" class="def record field anchored"><a href="#type-formatter_out_functions.out_string" class="anchor"></a><code><span>out_string : <span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_out_functions.out_flush" class="def record field anchored"><a href="#type-formatter_out_functions.out_flush" class="anchor"></a><code><span>out_flush : <span>unit <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_out_functions.out_newline" class="def record field anchored"><a href="#type-formatter_out_functions.out_newline" class="anchor"></a><code><span>out_newline : <span>unit <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_out_functions.out_spaces" class="def record field anchored"><a href="#type-formatter_out_functions.out_spaces" class="anchor"></a><code><span>out_spaces : <span>int <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_out_functions.out_indent" class="def record field anchored"><a href="#type-formatter_out_functions.out_indent" class="anchor"></a><code><span>out_indent : <span>int <span class="arrow">-></span></span> unit;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_formatter_out_functions"><a href="#val-pp_set_formatter_out_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_formatter_out_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter_out_functions">formatter_out_functions</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_formatter_out_functions"><a href="#val-set_formatter_out_functions" class="anchor"></a><code><span><span class="keyword">val</span> set_formatter_out_functions : <span><a href="#type-formatter_out_functions">formatter_out_functions</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_formatter_out_functions"><a href="#val-pp_get_formatter_out_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_formatter_out_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-formatter_out_functions">formatter_out_functions</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_formatter_out_functions"><a href="#val-get_formatter_out_functions" class="anchor"></a><code><span><span class="keyword">val</span> get_formatter_out_functions : <span>unit <span class="arrow">-></span></span> <a href="#type-formatter_out_functions">formatter_out_functions</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-formatter_stag_functions"><a href="#type-formatter_stag_functions" class="anchor"></a><code><span><span class="keyword">type</span> formatter_stag_functions</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.formatter_stag_functions</span><span> = </span><span>{</span></code><ol><li id="type-formatter_stag_functions.mark_open_stag" class="def record field anchored"><a href="#type-formatter_stag_functions.mark_open_stag" class="anchor"></a><code><span>mark_open_stag : <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> string;</span></code></li><li id="type-formatter_stag_functions.mark_close_stag" class="def record field anchored"><a href="#type-formatter_stag_functions.mark_close_stag" class="anchor"></a><code><span>mark_close_stag : <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> string;</span></code></li><li id="type-formatter_stag_functions.print_open_stag" class="def record field anchored"><a href="#type-formatter_stag_functions.print_open_stag" class="anchor"></a><code><span>print_open_stag : <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_stag_functions.print_close_stag" class="def record field anchored"><a href="#type-formatter_stag_functions.print_close_stag" class="anchor"></a><code><span>print_close_stag : <span><a href="#type-stag">stag</a> <span class="arrow">-></span></span> unit;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_formatter_stag_functions"><a href="#val-pp_set_formatter_stag_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_formatter_stag_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter_stag_functions">formatter_stag_functions</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_formatter_stag_functions"><a href="#val-set_formatter_stag_functions" class="anchor"></a><code><span><span class="keyword">val</span> set_formatter_stag_functions : <span><a href="#type-formatter_stag_functions">formatter_stag_functions</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_formatter_stag_functions"><a href="#val-pp_get_formatter_stag_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_formatter_stag_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-formatter_stag_functions">formatter_stag_functions</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_formatter_stag_functions"><a href="#val-get_formatter_stag_functions" class="anchor"></a><code><span><span class="keyword">val</span> get_formatter_stag_functions : <span>unit <span class="arrow">-></span></span> <a href="#type-formatter_stag_functions">formatter_stag_functions</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-formatter_of_out_channel"><a href="#val-formatter_of_out_channel" class="anchor"></a><code><span><span class="keyword">val</span> formatter_of_out_channel : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-std_formatter"><a href="#val-std_formatter" class="anchor"></a><code><span><span class="keyword">val</span> std_formatter : <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err_formatter"><a href="#val-err_formatter" class="anchor"></a><code><span><span class="keyword">val</span> err_formatter : <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-formatter_of_buffer"><a href="#val-formatter_of_buffer" class="anchor"></a><code><span><span class="keyword">val</span> formatter_of_buffer : <span><span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stdbuf"><a href="#val-stdbuf" class="anchor"></a><code><span><span class="keyword">val</span> stdbuf : <span class="xref-unresolved">Stdlib</span>.Buffer.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-str_formatter"><a href="#val-str_formatter" class="anchor"></a><code><span><span class="keyword">val</span> str_formatter : <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush_str_formatter"><a href="#val-flush_str_formatter" class="anchor"></a><code><span><span class="keyword">val</span> flush_str_formatter : <span>unit <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_formatter"><a href="#val-make_formatter" class="anchor"></a><code><span><span class="keyword">val</span> make_formatter :
|
||
<span><span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-formatter_of_out_functions"><a href="#val-formatter_of_out_functions" class="anchor"></a><code><span><span class="keyword">val</span> formatter_of_out_functions : <span><a href="#type-formatter_out_functions">formatter_out_functions</a> <span class="arrow">-></span></span> <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-symbolic_output_item"><a href="#type-symbolic_output_item" class="anchor"></a><code><span><span class="keyword">type</span> symbolic_output_item</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.symbolic_output_item</span><span> = </span></code><ol><li id="type-symbolic_output_item.Output_flush" class="def variant constructor anchored"><a href="#type-symbolic_output_item.Output_flush" class="anchor"></a><code><span>| </span><span><span class="constructor">Output_flush</span></span></code></li><li id="type-symbolic_output_item.Output_newline" class="def variant constructor anchored"><a href="#type-symbolic_output_item.Output_newline" class="anchor"></a><code><span>| </span><span><span class="constructor">Output_newline</span></span></code></li><li id="type-symbolic_output_item.Output_string" class="def variant constructor anchored"><a href="#type-symbolic_output_item.Output_string" class="anchor"></a><code><span>| </span><span><span class="constructor">Output_string</span> <span class="keyword">of</span> string</span></code></li><li id="type-symbolic_output_item.Output_spaces" class="def variant constructor anchored"><a href="#type-symbolic_output_item.Output_spaces" class="anchor"></a><code><span>| </span><span><span class="constructor">Output_spaces</span> <span class="keyword">of</span> int</span></code></li><li id="type-symbolic_output_item.Output_indent" class="def variant constructor anchored"><a href="#type-symbolic_output_item.Output_indent" class="anchor"></a><code><span>| </span><span><span class="constructor">Output_indent</span> <span class="keyword">of</span> int</span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-symbolic_output_buffer"><a href="#type-symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">type</span> symbolic_output_buffer</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.symbolic_output_buffer</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_symbolic_output_buffer"><a href="#val-make_symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">val</span> make_symbolic_output_buffer : <span>unit <span class="arrow">-></span></span> <a href="#type-symbolic_output_buffer">symbolic_output_buffer</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-clear_symbolic_output_buffer"><a href="#val-clear_symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">val</span> clear_symbolic_output_buffer : <span><a href="#type-symbolic_output_buffer">symbolic_output_buffer</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_symbolic_output_buffer"><a href="#val-get_symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">val</span> get_symbolic_output_buffer :
|
||
<span><a href="#type-symbolic_output_buffer">symbolic_output_buffer</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-symbolic_output_item">symbolic_output_item</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush_symbolic_output_buffer"><a href="#val-flush_symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">val</span> flush_symbolic_output_buffer :
|
||
<span><a href="#type-symbolic_output_buffer">symbolic_output_buffer</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-symbolic_output_item">symbolic_output_item</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_symbolic_output_item"><a href="#val-add_symbolic_output_item" class="anchor"></a><code><span><span class="keyword">val</span> add_symbolic_output_item :
|
||
<span><a href="#type-symbolic_output_buffer">symbolic_output_buffer</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-symbolic_output_item">symbolic_output_item</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-formatter_of_symbolic_output_buffer"><a href="#val-formatter_of_symbolic_output_buffer" class="anchor"></a><code><span><span class="keyword">val</span> formatter_of_symbolic_output_buffer : <span><a href="#type-symbolic_output_buffer">symbolic_output_buffer</a> <span class="arrow">-></span></span> <a href="#type-formatter">formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_list"><a href="#val-pp_print_list" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_list :
|
||
<span>?pp_sep:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_seq"><a href="#val-pp_print_seq" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_seq :
|
||
<span>?pp_sep:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> <span class="xref-unresolved">Stdlib</span>.Seq.t</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_text"><a href="#val-pp_print_text" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_text : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_option"><a href="#val-pp_print_option" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_option :
|
||
<span>?none:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> option</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_result"><a href="#val-pp_print_result" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_result :
|
||
<span>ok:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>error:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'e</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_print_either"><a href="#val-pp_print_either" class="anchor"></a><code><span><span class="keyword">val</span> pp_print_either :
|
||
<span>left:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>right:<span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.Either.t</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-printf"><a href="#val-printf" class="anchor"></a><code><span><span class="keyword">val</span> printf : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eprintf"><a href="#val-eprintf" class="anchor"></a><code><span><span class="keyword">val</span> eprintf : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-asprintf"><a href="#val-asprintf" class="anchor"></a><code><span><span class="keyword">val</span> asprintf : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit, string)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dprintf"><a href="#val-dprintf" class="anchor"></a><code><span><span class="keyword">val</span> dprintf : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit, <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> unit)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ifprintf"><a href="#val-ifprintf" class="anchor"></a><code><span><span class="keyword">val</span> ifprintf : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kfprintf"><a href="#val-kfprintf" class="anchor"></a><code><span><span class="keyword">val</span> kfprintf :
|
||
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'b</span>, <a href="#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kdprintf"><a href="#val-kdprintf" class="anchor"></a><code><span><span class="keyword">val</span> kdprintf :
|
||
<span><span>(<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'b</span>, <a href="#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ikfprintf"><a href="#val-ikfprintf" class="anchor"></a><code><span><span class="keyword">val</span> ikfprintf :
|
||
<span><span>(<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'b</span>, <a href="#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kasprintf"><a href="#val-kasprintf" class="anchor"></a><code><span><span class="keyword">val</span> kasprintf :
|
||
<span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'b</span>, <a href="#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'b</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bprintf"><a href="#val-bprintf" class="anchor"></a><code><span><span class="keyword">val</span> bprintf : <span><span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-formatter">formatter</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> </li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kprintf"><a href="#val-kprintf" class="anchor"></a><code><span><span class="keyword">val</span> kprintf : <span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, unit, string, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'b</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.ksprintf instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_all_formatter_output_functions"><a href="#val-set_all_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> set_all_formatter_output_functions :
|
||
<span>out:<span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>flush:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>newline:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>spaces:<span>(<span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.set_formatter_out_functions instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_all_formatter_output_functions"><a href="#val-get_all_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> get_all_formatter_output_functions :
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span>(<span>string <span class="arrow">-></span></span>
|
||
<span>int <span class="arrow">-></span></span>
|
||
<span>int <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>unit <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>unit <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>int <span class="arrow">-></span></span>
|
||
unit)</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.get_formatter_out_functions instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_all_formatter_output_functions"><a href="#val-pp_set_all_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_all_formatter_output_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>out:<span>(<span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>flush:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>newline:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
<span>spaces:<span>(<span>int <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.pp_set_formatter_out_functions instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_all_formatter_output_functions"><a href="#val-pp_get_all_formatter_output_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_all_formatter_output_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span>(<span>string <span class="arrow">-></span></span>
|
||
<span>int <span class="arrow">-></span></span>
|
||
<span>int <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>unit <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>unit <span class="arrow">-></span></span>
|
||
unit)</span>
|
||
* <span>(<span>int <span class="arrow">-></span></span>
|
||
unit)</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.pp_get_formatter_out_functions instead.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_open_tag"><a href="#val-pp_open_tag" class="anchor"></a><code><span><span class="keyword">val</span> pp_open_tag : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.pp_open_stag.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-open_tag"><a href="#val-open_tag" class="anchor"></a><code><span><span class="keyword">val</span> open_tag : <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.open_stag.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_close_tag"><a href="#val-pp_close_tag" class="anchor"></a><code><span><span class="keyword">val</span> pp_close_tag : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.pp_close_stag.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close_tag"><a href="#val-close_tag" class="anchor"></a><code><span><span class="keyword">val</span> close_tag : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.close_stag.</li></ul></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-formatter_tag_functions"><a href="#type-formatter_tag_functions" class="anchor"></a><code><span><span class="keyword">type</span> formatter_tag_functions</span><span> = <span class="xref-unresolved">Stdlib__Format</span>.formatter_tag_functions</span><span> = </span><span>{</span></code><ol><li id="type-formatter_tag_functions.mark_open_tag" class="def record field anchored"><a href="#type-formatter_tag_functions.mark_open_tag" class="anchor"></a><code><span>mark_open_tag : <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> string;</span></code></li><li id="type-formatter_tag_functions.mark_close_tag" class="def record field anchored"><a href="#type-formatter_tag_functions.mark_close_tag" class="anchor"></a><code><span>mark_close_tag : <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> string;</span></code></li><li id="type-formatter_tag_functions.print_open_tag" class="def record field anchored"><a href="#type-formatter_tag_functions.print_open_tag" class="anchor"></a><code><span>print_open_tag : <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> unit;</span></code></li><li id="type-formatter_tag_functions.print_close_tag" class="def record field anchored"><a href="#type-formatter_tag_functions.print_close_tag" class="anchor"></a><code><span>print_close_tag : <span><a href="#type-tag">tag</a> <span class="arrow">-></span></span> unit;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use formatter_stag_functions.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_set_formatter_tag_functions"><a href="#val-pp_set_formatter_tag_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_set_formatter_tag_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-formatter_tag_functions">formatter_tag_functions</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> This function will erase non-string tag formatting functions. Use Format.pp_set_formatter_stag_functions.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_formatter_tag_functions"><a href="#val-set_formatter_tag_functions" class="anchor"></a><code><span><span class="keyword">val</span> set_formatter_tag_functions : <span><a href="#type-formatter_tag_functions">formatter_tag_functions</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.set_formatter_stag_functions.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_get_formatter_tag_functions"><a href="#val-pp_get_formatter_tag_functions" class="anchor"></a><code><span><span class="keyword">val</span> pp_get_formatter_tag_functions :
|
||
<span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-formatter_tag_functions">formatter_tag_functions</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.pp_get_formatter_stag_functions.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_formatter_tag_functions"><a href="#val-get_formatter_tag_functions" class="anchor"></a><code><span><span class="keyword">val</span> get_formatter_tag_functions : <span>unit <span class="arrow">-></span></span> <a href="#type-formatter_tag_functions">formatter_tag_functions</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Format.get_formatter_stag_functions.</li></ul></div></div></details></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span class="xref-unresolved">Stdlib</span>.Format.formatter</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span><span class="keyword">type</span> <span>-'a printer</span></span><span> = <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><h3 id="combinators"><a href="#combinators" class="anchor"></a>Combinators</h3><div class="odoc-spec"><div class="spec value anchored" id="val-silent"><a href="#val-silent" class="anchor"></a><code><span><span class="keyword">val</span> silent : <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Prints nothing.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unit"><a href="#val-unit" class="anchor"></a><code><span><span class="keyword">val</span> unit : <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Prints "()".</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-int"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int : <span>int <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string"><a href="#val-string" class="anchor"></a><code><span><span class="keyword">val</span> string : <span>string <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bool"><a href="#val-bool" class="anchor"></a><code><span><span class="keyword">val</span> bool : <span>bool <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-float3"><a href="#val-float3" class="anchor"></a><code><span><span class="keyword">val</span> float3 : <span>float <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-float"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float : <span>float <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exn"><a href="#val-exn" class="anchor"></a><code><span><span class="keyword">val</span> exn : <span>exn <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Printer using <code>Printexc</code>.to_string.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-space"><a href="#val-space" class="anchor"></a><code><span><span class="keyword">val</span> space : <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-pp_print_space"><code>pp_print_space</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cut"><a href="#val-cut" class="anchor"></a><code><span><span class="keyword">val</span> cut : <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-pp_print_cut"><code>pp_print_cut</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-break"><a href="#val-break" class="anchor"></a><code><span><span class="keyword">val</span> break : <span><span>(int * int)</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Tuple-ized <a href="#type-printer"><code>printer</code></a> form of <a href="#val-pp_print_break"><code>pp_print_break</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-newline"><a href="#val-newline" class="anchor"></a><code><span><span class="keyword">val</span> newline : <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Force newline (see <code>Format</code>.pp_force_newline).</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-substring"><a href="#val-substring" class="anchor"></a><code><span><span class="keyword">val</span> substring : <span><span>(string * int * int)</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>substring (s,i,len)</code> prints the substring <code>(s,i,len)</code>, where <code>i</code> is the offset in <code>s</code> and <code>len</code> the number of bytes in the substring.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Invalid_argument</span> <p>if the triple <code>(s,i,len)</code> does not describe a proper substring.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-text"><a href="#val-text" class="anchor"></a><code><span><span class="keyword">val</span> text : <span>string <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Print string, but replacing spaces with breaks and newlines with <a href="#val-newline"><code>newline</code></a>. See <code>pp_print_text</code> on recent versions of OCaml.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_lines"><a href="#val-string_lines" class="anchor"></a><code><span><span class="keyword">val</span> string_lines : <span>string <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>string_lines out s</code> prints <code>s</code> with all newlines (<code>'\n'</code>) replaced by a cut, in a vertical box. It does <b>NOT</b> insert breakable spaces in place of spaces, unlike <a href="#val-text"><code>text</code></a>. This means an already formatted string can be displayed inside another formatter without mangling the indentation.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-char"><a href="#val-char" class="anchor"></a><code><span><span class="keyword">val</span> char : <span>char <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-int32"><a href="#val-int32" class="anchor"></a><code><span><span class="keyword">val</span> int32 : <span>int32 <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-int64"><a href="#val-int64" class="anchor"></a><code><span><span class="keyword">val</span> int64 : <span>int64 <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-nativeint"><a href="#val-nativeint" class="anchor"></a><code><span><span class="keyword">val</span> nativeint : <span>nativeint <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Alias to <code>Format</code>.pp_print_flush.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_quoted"><a href="#val-string_quoted" class="anchor"></a><code><span><span class="keyword">val</span> string_quoted : <span>string <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Similar to <code>CCString</code>.print.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-list"><a href="#val-list" class="anchor"></a><code><span><span class="keyword">val</span> list : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> list</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-array"><a href="#val-array" class="anchor"></a><code><span><span class="keyword">val</span> array : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> array</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-arrayi"><a href="#val-arrayi" class="anchor"></a><code><span><span class="keyword">val</span> arrayi : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span>(int * <span class="type-var">'a</span>)</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> array</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-seq"><a href="#val-seq" class="anchor"></a><code><span><span class="keyword">val</span> seq : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <span class="xref-unresolved">Stdlib</span>.Seq.t</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iter"><a href="#val-iter" class="anchor"></a><code><span><span class="keyword">val</span> iter : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-iter">iter</a></span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-opt"><a href="#val-opt" class="anchor"></a><code><span><span class="keyword">val</span> opt : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> option</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>opt pp</code> prints options as follows:</p><ul><li><code>Some x</code> will become "some foo" if <code>pp x ---> "foo"</code>.</li><li><code>None</code> will become "none".</li></ul></div></div><p>In the tuple printers, the <code>sep</code> argument is only available.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul><div class="odoc-spec"><div class="spec value anchored" id="val-pair"><a href="#val-pair" class="anchor"></a><code><span><span class="keyword">val</span> pair : <span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-triple"><a href="#val-triple" class="anchor"></a><code><span><span class="keyword">val</span> triple :
|
||
<span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'b</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'c</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span> * <span class="type-var">'c</span>)</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-quad"><a href="#val-quad" class="anchor"></a><code><span><span class="keyword">val</span> quad :
|
||
<span>?sep:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'b</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'c</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'d</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span>
|
||
<span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span> * <span class="type-var">'c</span> * <span class="type-var">'d</span>)</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-append"><a href="#val-append" class="anchor"></a><code><span><span class="keyword">val</span> append : <span><span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>append ppa ppb</code> first prints <code>ppa ()</code>, then prints <code>ppb ()</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-append_l"><a href="#val-append_l" class="anchor"></a><code><span><span class="keyword">val</span> append_l : <span><span><span>unit <a href="#type-printer">printer</a></span> list</span> <span class="arrow">-></span></span> <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>append_l pps</code> runs the printers in <code>pps</code> sequentially.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-within"><a href="#val-within" class="anchor"></a><code><span><span class="keyword">val</span> within : <span>string <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>within a b p</code> wraps <code>p</code> inside the strings <code>a</code> and <code>b</code>. Convenient, for instances, for brackets, parenthesis, quotes, etc.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-vbox"><a href="#val-vbox" class="anchor"></a><code><span><span class="keyword">val</span> vbox : <span>?i:int <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Wrap the printer in a vertical box.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">i</span> <p>level of indentation within the box (default 0).</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hvbox"><a href="#val-hvbox" class="anchor"></a><code><span><span class="keyword">val</span> hvbox : <span>?i:int <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Wrap the printer in a horizontal/vertical box.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">i</span> <p>level of indentation within the box (default 0).</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hovbox"><a href="#val-hovbox" class="anchor"></a><code><span><span class="keyword">val</span> hovbox : <span>?i:int <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Wrap the printer in a horizontal or vertical box.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">i</span> <p>level of indentation within the box (default 0).</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hbox"><a href="#val-hbox" class="anchor"></a><code><span><span class="keyword">val</span> hbox : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Wrap the printer in an horizontal box.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>, <span class="type-var">_</span>, <span class="type-var">'a</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>return "some_format_string"</code> takes a argument-less format string and returns a printer actionable by <code>()</code>. Examples:</p><ul><li><code>return ",@ "</code></li><li><code>return "@{<Red>and then@}@,"</code></li><li><code>return "@[<v>a@ b@]"</code></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_to_string"><a href="#val-of_to_string" class="anchor"></a><code><span><span class="keyword">val</span> of_to_string : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> string)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>of_to_string f</code> converts its input to a string using <code>f</code>, then prints the string.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-const"><a href="#val-const" class="anchor"></a><code><span><span class="keyword">val</span> const : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>const pp x</code> is a unit printer that uses <code>pp</code> on <code>x</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-some"><a href="#val-some" class="anchor"></a><code><span><span class="keyword">val</span> some : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> option</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>some pp</code> will print options as follows:</p><ul><li><code>Some x</code> is printed using <code>pp</code> on <code>x</code></li><li><code>None</code> is not printed at all</li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-const_string"><a href="#val-const_string" class="anchor"></a><code><span><span class="keyword">val</span> const_string : <span>string <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>const_string s</code> is a printer that ignores its input and always prints <code>s</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.5</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-opaque"><a href="#val-opaque" class="anchor"></a><code><span><span class="keyword">val</span> opaque : <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>opaque</code> is <code>const_string "opaque"</code>. The exact string used is not stable.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.5</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lazy_force"><a href="#val-lazy_force" class="anchor"></a><code><span><span class="keyword">val</span> lazy_force : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> lazy_t</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>lazy_force pp out x</code> forces <code>x</code> and prints the result with <code>pp</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lazy_or"><a href="#val-lazy_or" class="anchor"></a><code><span><span class="keyword">val</span> lazy_or : <span>?default:<span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> lazy_t</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>lazy_or ?default pp out x</code> prints <code>default</code> if <code>x</code> is not evaluated yet, or uses <code>pp</code> otherwise.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.0</li></ul></div></div><h3 id="ansi-codes"><a href="#ansi-codes" class="anchor"></a>ANSI codes</h3><p>Use ANSI escape codes https://en.wikipedia.org/wiki/ANSI_escape_code to put some colors on the terminal.</p><p>This uses <b>tags</b> in format strings to specify the style. Current styles are the following:</p><ul><li>"reset" resets style</li><li>"black"</li><li>"red"</li><li>"green"</li><li>"yellow"</li><li>"blue"</li><li>"magenta"</li><li>"cyan"</li><li>"white"</li><li>"bold" bold font</li><li>"Black" bold black</li><li>"Red" bold red</li><li>"Green" bold green</li><li>"Yellow" bold yellow</li><li>"Blue" bold blue</li><li>"Magenta" bold magenta</li><li>"Cyan" bold cyan</li><li>"White" bold white</li></ul><p>Example:</p><pre class="language-ocaml"><code>set_color_default true;;
|
||
|
||
Format.printf
|
||
"what is your @{<White>favorite color@}? @{<blue>blue@}! No, @{<red>red@}! Ahhhhhhh@.";;</code></pre><p><b>status: unstable</b></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.15</li></ul><div class="odoc-spec"><div class="spec value anchored" id="val-set_color_tag_handling"><a href="#val-set_color_tag_handling" class="anchor"></a><code><span><span class="keyword">val</span> set_color_tag_handling : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add functions to support color tags to the given formatter.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.15</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_color_default"><a href="#val-set_color_default" class="anchor"></a><code><span><span class="keyword">val</span> set_color_default : <span>bool <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set_color_default b</code> enables color handling on the standard formatters (stdout, stderr) if <code>b = true</code> as well as on <a href="#val-sprintf"><code>sprintf</code></a> formatters; it disables the color handling if <code>b = false</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_color"><a href="#val-with_color" class="anchor"></a><code><span><span class="keyword">val</span> with_color : <span>string <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>with_color "Blue" pp</code> behaves like the printer <code>pp</code>, but with the given style.</p><p><b>status: unstable</b></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_colorf"><a href="#val-with_colorf" class="anchor"></a><code><span><span class="keyword">val</span> with_colorf : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, unit)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_colorf "Blue" out "%s %d" "yolo" 42</code> will behave like <code>Format</code>.fprintf, but wrapping the content with the given style.</p><p><b>status: unstable</b></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_color_sf"><a href="#val-with_color_sf" class="anchor"></a><code><span><span class="keyword">val</span> with_color_sf : <span>string <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, string)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_color_sf "Blue" out "%s %d" "yolo" 42</code> will behave like <a href="#val-sprintf"><code>sprintf</code></a>, but wrapping the content with the given style.</p><p>Example:</p><pre class="language-ocaml"><code>CCFormat.with_color_sf "red" "%a" CCFormat.Dump.(list int) [1;2;3] |> print_endline;;</code></pre><p><b>status: unstable</b></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.21</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_color_ksf"><a href="#val-with_color_ksf" class="anchor"></a><code><span><span class="keyword">val</span> with_color_ksf :
|
||
<span>f:<span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_color_ksf "Blue" ~f "%s %d" "yolo" 42</code> will behave like <a href="#val-ksprintf"><code>ksprintf</code></a>, but wrapping the content with the given style.</p><p>Example: the following with raise <code>Failure</code> with a colored message</p><pre class="language-ocaml"><code>CCFormat.with_color_ksf "red" ~f:failwith "%a" CCFormat.Dump.(list int) [1;2;3];;</code></pre><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-ANSI_codes"><a href="#module-ANSI_codes" class="anchor"></a><code><span><span class="keyword">module</span> <a href="ANSI_codes/index.html">ANSI_codes</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>ANSI escape codes. This contains lower level functions for them.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-styling"><a href="#val-styling" class="anchor"></a><code><span><span class="keyword">val</span> styling : <span><span><a href="ANSI_codes/index.html#type-style">ANSI_codes.style</a> list</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p><code>styling st p</code> is the same printer as <code>p</code>, except it locally sets the style <code>st</code>.</p><p>Example:</p><pre class="language-ocaml"><code>open CCFormat;
|
||
set_color_default true;
|
||
sprintf
|
||
"what is your %a? %a! No, %a! Ahhhhhhh@."
|
||
(styling [`FG `White; `Bold] string) "favorite color"
|
||
(styling [`FG `Blue] string) "blue"
|
||
(styling [`FG `Red] string) "red"</code></pre><p>Available only on OCaml >= 4.08.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_styling"><a href="#val-with_styling" class="anchor"></a><code><span><span class="keyword">val</span> with_styling : <span><span><a href="ANSI_codes/index.html#type-style">ANSI_codes.style</a> list</span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_styling style fmt f</code> sets the given style on <code>fmt</code>, calls <code>f()</code>, then restores the previous style. It is useful in imperative-style printers (a sequence of "print a; print b; …").</p><p>Available only on OCaml >= 4.08.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.7</li></ul></div></div><h3 id="io"><a href="#io" class="anchor"></a>IO</h3><div class="odoc-spec"><div class="spec value anchored" id="val-output"><a href="#val-output" class="anchor"></a><code><span><span class="keyword">val</span> output : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_chan"><a href="#val-of_chan" class="anchor"></a><code><span><span class="keyword">val</span> of_chan : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Alias to <code>Format</code>.formatter_of_out_channel.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_out_chan"><a href="#val-with_out_chan" class="anchor"></a><code><span><span class="keyword">val</span> with_out_chan : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> <span><span>(<span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_out_chan oc f</code> turns <code>oc</code> into a formatter <code>fmt</code>, and call <code>f fmt</code>. Behaves like <code>f fmt</code> from then on, but whether the call to <code>f</code> fails or returns, <code>fmt</code> is flushed before the call terminates.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stdout"><a href="#val-stdout" class="anchor"></a><code><span><span class="keyword">val</span> stdout : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stderr"><a href="#val-stderr" class="anchor"></a><code><span><span class="keyword">val</span> stderr : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee"><a href="#val-tee" class="anchor"></a><code><span><span class="keyword">val</span> tee : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>tee a b</code> makes a new formatter that writes in both <code>a</code> and <code>b</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sprintf"><a href="#val-sprintf" class="anchor"></a><code><span><span class="keyword">val</span> sprintf : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, string)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Print into a string any format string that would usually be compatible with <a href="#val-fprintf"><code>fprintf</code></a>. Like <code>Format</code>.asprintf.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sprintf_no_color"><a href="#val-sprintf_no_color" class="anchor"></a><code><span><span class="keyword">val</span> sprintf_no_color : <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, string)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-sprintf"><code>sprintf</code></a> but never prints colors.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.16</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sprintf_dyn_color"><a href="#val-sprintf_dyn_color" class="anchor"></a><code><span><span class="keyword">val</span> sprintf_dyn_color :
|
||
<span>colors:bool <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, string)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-sprintf"><code>sprintf</code></a> but enable/disable colors depending on <code>colors</code>.</p><p>Example:</p><pre class="language-ocaml"><code>(* with colors *)
|
||
CCFormat.sprintf_dyn_color ~colors:true "@{<Red>%a@}"
|
||
CCFormat.Dump.(list int) [1;2;3] |> print_endline;;
|
||
|
||
(* without colors *)
|
||
CCFormat.sprintf_dyn_color ~colors:false "@{<Red>%a@}"
|
||
CCFormat.Dump.(list int) [1;2;3] |> print_endline;;</code></pre><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.21</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fprintf"><a href="#val-fprintf" class="anchor"></a><code><span><span class="keyword">val</span> fprintf : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Alias to <code>Format</code>.fprintf.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fprintf_dyn_color"><a href="#val-fprintf_dyn_color" class="anchor"></a><code><span><span class="keyword">val</span> fprintf_dyn_color : <span>colors:bool <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit)</span> <span class="xref-unresolved">Stdlib</span>.format</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-fprintf"><code>fprintf</code></a> but enable/disable colors depending on <code>colors</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.21</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ksprintf"><a href="#val-ksprintf" class="anchor"></a><code><span><span class="keyword">val</span> ksprintf :
|
||
<span>?margin:int <span class="arrow">-></span></span>
|
||
<span>f:<span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>ksprintf fmt ~f</code> formats using <code>fmt</code>, in a way similar to <a href="#val-sprintf"><code>sprintf</code></a>, and then calls <code>f</code> on the resulting string.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">margin</span> <p>set margin (since 2.1)</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.14</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_file"><a href="#val-to_file" class="anchor"></a><code><span><span class="keyword">val</span> to_file : <span>string <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-t">t</a>, unit, unit)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Print to the given file.</p></div></div><h3 id="dump"><a href="#dump" class="anchor"></a>Dump</h3><p>Print structures as OCaml values, so that they can be parsed back by OCaml (typically, in the toplevel, for debugging).</p><p>Example:</p><pre class="language-ocaml"><code>Format.printf "%a@." CCFormat.Dump.(list int) CCList.(1 -- 200);;
|
||
|
||
Format.printf "%a@." CCFormat.Dump.(array (list (pair int bool)))
|
||
[| [1, true; 2, false]; []; [42, false] |];;</code></pre><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.21</li></ul><div class="odoc-spec"><div class="spec module anchored" id="module-Dump"><a href="#module-Dump" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Dump/index.html">Dump</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Infix"><a href="#module-Infix" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Infix/index.html">Infix</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <a href="Infix/index.html">Infix</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-(++)"><a href="#val-(++)" class="anchor"></a><code><span><span class="keyword">val</span> (++) : <span><span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span><span>unit <a href="#type-printer">printer</a></span> <span class="arrow">-></span></span> <span>unit <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>Alias to <a href="#val-append"><code>append</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.2</li></ul></div></div></details></div></div></body></html> |