mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
14 lines
No EOL
70 KiB
HTML
14 lines
No EOL
70 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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCFormat</nav><h1>Module <code>CCFormat</code></h1><h2 id="helpers-for-format"><a href="#helpers-for-format" class="anchor"></a>Helpers for Format</h2><dl><dt>since</dt><dd>0.8</dd></dl><nav class="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></header><dl><dt class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><code><span class="keyword">type </span>'a sequence</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span> <span>-></span> unit) <span>-></span> unit</code></dt></dl><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><span class="keyword">sig</span> ... <span class="keyword">end</span></code></span></summary><dl><dt class="spec type" id="type-formatter"><a href="#type-formatter" class="anchor"></a><code><span class="keyword">type </span>formatter</code><code><span class="keyword"> = </span>Format.formatter</code></dt></dl><dl><dt class="spec value" id="val-pp_open_box"><a href="#val-pp_open_box" class="anchor"></a><code><span class="keyword">val </span>pp_open_box : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-open_box"><a href="#val-open_box" class="anchor"></a><code><span class="keyword">val </span>open_box : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_close_box"><a href="#val-pp_close_box" class="anchor"></a><code><span class="keyword">val </span>pp_close_box : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-close_box"><a href="#val-close_box" class="anchor"></a><code><span class="keyword">val </span>close_box : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_open_hbox"><a href="#val-pp_open_hbox" class="anchor"></a><code><span class="keyword">val </span>pp_open_hbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-open_hbox"><a href="#val-open_hbox" class="anchor"></a><code><span class="keyword">val </span>open_hbox : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_open_vbox"><a href="#val-pp_open_vbox" class="anchor"></a><code><span class="keyword">val </span>pp_open_vbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-open_vbox"><a href="#val-open_vbox" class="anchor"></a><code><span class="keyword">val </span>open_vbox : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_open_hvbox"><a href="#val-pp_open_hvbox" class="anchor"></a><code><span class="keyword">val </span>pp_open_hvbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-open_hvbox"><a href="#val-open_hvbox" class="anchor"></a><code><span class="keyword">val </span>open_hvbox : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_open_hovbox"><a href="#val-pp_open_hovbox" class="anchor"></a><code><span class="keyword">val </span>pp_open_hovbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-open_hovbox"><a href="#val-open_hovbox" class="anchor"></a><code><span class="keyword">val </span>open_hovbox : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_string"><a href="#val-pp_print_string" class="anchor"></a><code><span class="keyword">val </span>pp_print_string : <a href="index.html#type-formatter">formatter</a> <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-print_string"><a href="#val-print_string" class="anchor"></a><code><span class="keyword">val </span>print_string : string <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_as"><a href="#val-pp_print_as" class="anchor"></a><code><span class="keyword">val </span>pp_print_as : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-print_as"><a href="#val-print_as" class="anchor"></a><code><span class="keyword">val </span>print_as : int <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_int"><a href="#val-pp_print_int" class="anchor"></a><code><span class="keyword">val </span>pp_print_int : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-print_int"><a href="#val-print_int" class="anchor"></a><code><span class="keyword">val </span>print_int : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_float"><a href="#val-pp_print_float" class="anchor"></a><code><span class="keyword">val </span>pp_print_float : <a href="index.html#type-formatter">formatter</a> <span>-></span> float <span>-></span> unit</code></dt><dt class="spec value" id="val-print_float"><a href="#val-print_float" class="anchor"></a><code><span class="keyword">val </span>print_float : float <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_char"><a href="#val-pp_print_char" class="anchor"></a><code><span class="keyword">val </span>pp_print_char : <a href="index.html#type-formatter">formatter</a> <span>-></span> char <span>-></span> unit</code></dt><dt class="spec value" id="val-print_char"><a href="#val-print_char" class="anchor"></a><code><span class="keyword">val </span>print_char : char <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_bool"><a href="#val-pp_print_bool" class="anchor"></a><code><span class="keyword">val </span>pp_print_bool : <a href="index.html#type-formatter">formatter</a> <span>-></span> bool <span>-></span> unit</code></dt><dt class="spec value" id="val-print_bool"><a href="#val-print_bool" class="anchor"></a><code><span class="keyword">val </span>print_bool : bool <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_space"><a href="#val-pp_print_space" class="anchor"></a><code><span class="keyword">val </span>pp_print_space : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_space"><a href="#val-print_space" class="anchor"></a><code><span class="keyword">val </span>print_space : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_cut"><a href="#val-pp_print_cut" class="anchor"></a><code><span class="keyword">val </span>pp_print_cut : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_cut"><a href="#val-print_cut" class="anchor"></a><code><span class="keyword">val </span>print_cut : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_break"><a href="#val-pp_print_break" class="anchor"></a><code><span class="keyword">val </span>pp_print_break : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-print_break"><a href="#val-print_break" class="anchor"></a><code><span class="keyword">val </span>print_break : int <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_force_newline"><a href="#val-pp_force_newline" class="anchor"></a><code><span class="keyword">val </span>pp_force_newline : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-force_newline"><a href="#val-force_newline" class="anchor"></a><code><span class="keyword">val </span>force_newline : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_if_newline"><a href="#val-pp_print_if_newline" class="anchor"></a><code><span class="keyword">val </span>pp_print_if_newline : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_if_newline"><a href="#val-print_if_newline" class="anchor"></a><code><span class="keyword">val </span>print_if_newline : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_flush"><a href="#val-pp_print_flush" class="anchor"></a><code><span class="keyword">val </span>pp_print_flush : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_flush"><a href="#val-print_flush" class="anchor"></a><code><span class="keyword">val </span>print_flush : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_newline"><a href="#val-pp_print_newline" class="anchor"></a><code><span class="keyword">val </span>pp_print_newline : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_newline"><a href="#val-print_newline" class="anchor"></a><code><span class="keyword">val </span>print_newline : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_margin"><a href="#val-pp_set_margin" class="anchor"></a><code><span class="keyword">val </span>pp_set_margin : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-set_margin"><a href="#val-set_margin" class="anchor"></a><code><span class="keyword">val </span>set_margin : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_margin"><a href="#val-pp_get_margin" class="anchor"></a><code><span class="keyword">val </span>pp_get_margin : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> int</code></dt><dt class="spec value" id="val-get_margin"><a href="#val-get_margin" class="anchor"></a><code><span class="keyword">val </span>get_margin : unit <span>-></span> int</code></dt><dt class="spec value" id="val-pp_set_max_indent"><a href="#val-pp_set_max_indent" class="anchor"></a><code><span class="keyword">val </span>pp_set_max_indent : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-set_max_indent"><a href="#val-set_max_indent" class="anchor"></a><code><span class="keyword">val </span>set_max_indent : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_max_indent"><a href="#val-pp_get_max_indent" class="anchor"></a><code><span class="keyword">val </span>pp_get_max_indent : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> int</code></dt><dt class="spec value" id="val-get_max_indent"><a href="#val-get_max_indent" class="anchor"></a><code><span class="keyword">val </span>get_max_indent : unit <span>-></span> int</code></dt><dt class="spec value" id="val-pp_set_max_boxes"><a href="#val-pp_set_max_boxes" class="anchor"></a><code><span class="keyword">val </span>pp_set_max_boxes : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-set_max_boxes"><a href="#val-set_max_boxes" class="anchor"></a><code><span class="keyword">val </span>set_max_boxes : int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_max_boxes"><a href="#val-pp_get_max_boxes" class="anchor"></a><code><span class="keyword">val </span>pp_get_max_boxes : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> int</code></dt><dt class="spec value" id="val-get_max_boxes"><a href="#val-get_max_boxes" class="anchor"></a><code><span class="keyword">val </span>get_max_boxes : unit <span>-></span> int</code></dt><dt class="spec value" id="val-pp_over_max_boxes"><a href="#val-pp_over_max_boxes" class="anchor"></a><code><span class="keyword">val </span>pp_over_max_boxes : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> bool</code></dt><dt class="spec value" id="val-over_max_boxes"><a href="#val-over_max_boxes" class="anchor"></a><code><span class="keyword">val </span>over_max_boxes : unit <span>-></span> bool</code></dt><dt class="spec value" id="val-pp_open_tbox"><a href="#val-pp_open_tbox" class="anchor"></a><code><span class="keyword">val </span>pp_open_tbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-open_tbox"><a href="#val-open_tbox" class="anchor"></a><code><span class="keyword">val </span>open_tbox : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_close_tbox"><a href="#val-pp_close_tbox" class="anchor"></a><code><span class="keyword">val </span>pp_close_tbox : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-close_tbox"><a href="#val-close_tbox" class="anchor"></a><code><span class="keyword">val </span>close_tbox : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_tab"><a href="#val-pp_set_tab" class="anchor"></a><code><span class="keyword">val </span>pp_set_tab : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-set_tab"><a href="#val-set_tab" class="anchor"></a><code><span class="keyword">val </span>set_tab : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_tab"><a href="#val-pp_print_tab" class="anchor"></a><code><span class="keyword">val </span>pp_print_tab : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-print_tab"><a href="#val-print_tab" class="anchor"></a><code><span class="keyword">val </span>print_tab : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_tbreak"><a href="#val-pp_print_tbreak" class="anchor"></a><code><span class="keyword">val </span>pp_print_tbreak : <a href="index.html#type-formatter">formatter</a> <span>-></span> int <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-print_tbreak"><a href="#val-print_tbreak" class="anchor"></a><code><span class="keyword">val </span>print_tbreak : int <span>-></span> int <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_ellipsis_text"><a href="#val-pp_set_ellipsis_text" class="anchor"></a><code><span class="keyword">val </span>pp_set_ellipsis_text : <a href="index.html#type-formatter">formatter</a> <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-set_ellipsis_text"><a href="#val-set_ellipsis_text" class="anchor"></a><code><span class="keyword">val </span>set_ellipsis_text : string <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_ellipsis_text"><a href="#val-pp_get_ellipsis_text" class="anchor"></a><code><span class="keyword">val </span>pp_get_ellipsis_text : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> string</code></dt><dt class="spec value" id="val-get_ellipsis_text"><a href="#val-get_ellipsis_text" class="anchor"></a><code><span class="keyword">val </span>get_ellipsis_text : unit <span>-></span> string</code></dt></dl><dl><dt class="spec type" id="type-tag"><a href="#type-tag" class="anchor"></a><code><span class="keyword">type </span>tag</code><code><span class="keyword"> = </span>string</code></dt></dl><dl><dt class="spec value" id="val-pp_open_tag"><a href="#val-pp_open_tag" class="anchor"></a><code><span class="keyword">val </span>pp_open_tag : <a href="index.html#type-formatter">formatter</a> <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-open_tag"><a href="#val-open_tag" class="anchor"></a><code><span class="keyword">val </span>open_tag : <a href="index.html#type-tag">tag</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_close_tag"><a href="#val-pp_close_tag" class="anchor"></a><code><span class="keyword">val </span>pp_close_tag : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit</code></dt><dt class="spec value" id="val-close_tag"><a href="#val-close_tag" class="anchor"></a><code><span class="keyword">val </span>close_tag : unit <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_tags"><a href="#val-pp_set_tags" class="anchor"></a><code><span class="keyword">val </span>pp_set_tags : <a href="index.html#type-formatter">formatter</a> <span>-></span> bool <span>-></span> unit</code></dt><dt class="spec value" id="val-set_tags"><a href="#val-set_tags" class="anchor"></a><code><span class="keyword">val </span>set_tags : bool <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_print_tags"><a href="#val-pp_set_print_tags" class="anchor"></a><code><span class="keyword">val </span>pp_set_print_tags : <a href="index.html#type-formatter">formatter</a> <span>-></span> bool <span>-></span> unit</code></dt><dt class="spec value" id="val-set_print_tags"><a href="#val-set_print_tags" class="anchor"></a><code><span class="keyword">val </span>set_print_tags : bool <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_mark_tags"><a href="#val-pp_set_mark_tags" class="anchor"></a><code><span class="keyword">val </span>pp_set_mark_tags : <a href="index.html#type-formatter">formatter</a> <span>-></span> bool <span>-></span> unit</code></dt><dt class="spec value" id="val-set_mark_tags"><a href="#val-set_mark_tags" class="anchor"></a><code><span class="keyword">val </span>set_mark_tags : bool <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_print_tags"><a href="#val-pp_get_print_tags" class="anchor"></a><code><span class="keyword">val </span>pp_get_print_tags : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> bool</code></dt><dt class="spec value" id="val-get_print_tags"><a href="#val-get_print_tags" class="anchor"></a><code><span class="keyword">val </span>get_print_tags : unit <span>-></span> bool</code></dt><dt class="spec value" id="val-pp_get_mark_tags"><a href="#val-pp_get_mark_tags" class="anchor"></a><code><span class="keyword">val </span>pp_get_mark_tags : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> bool</code></dt><dt class="spec value" id="val-get_mark_tags"><a href="#val-get_mark_tags" class="anchor"></a><code><span class="keyword">val </span>get_mark_tags : unit <span>-></span> bool</code></dt><dt class="spec value" id="val-pp_set_formatter_out_channel"><a href="#val-pp_set_formatter_out_channel" class="anchor"></a><code><span class="keyword">val </span>pp_set_formatter_out_channel : <a href="index.html#type-formatter">formatter</a> <span>-></span> Pervasives.out_channel <span>-></span> unit</code></dt><dt class="spec value" id="val-set_formatter_out_channel"><a href="#val-set_formatter_out_channel" class="anchor"></a><code><span class="keyword">val </span>set_formatter_out_channel : Pervasives.out_channel <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_set_formatter_output_functions"><a href="#val-pp_set_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>pp_set_formatter_output_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> (string <span>-></span> int <span>-></span> int <span>-></span> unit) <span>-></span> (unit <span>-></span> unit) <span>-></span> unit</code></dt><dt class="spec value" id="val-set_formatter_output_functions"><a href="#val-set_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>set_formatter_output_functions : (string <span>-></span> int <span>-></span> int <span>-></span> unit) <span>-></span> (unit <span>-></span> unit) <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_formatter_output_functions"><a href="#val-pp_get_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>pp_get_formatter_output_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> (string <span>-></span> int <span>-></span> int <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)</code></dt><dt class="spec value" id="val-get_formatter_output_functions"><a href="#val-get_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>get_formatter_output_functions : unit <span>-></span> (string <span>-></span> int <span>-></span> int <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)</code></dt></dl><dl><dt class="spec type" id="type-formatter_out_functions"><a href="#type-formatter_out_functions" class="anchor"></a><code><span class="keyword">type </span>formatter_out_functions</code><code><span class="keyword"> = </span>Format.formatter_out_functions</code><code><span class="keyword"> = </span></code><code>{</code><table class="record"><tr id="type-formatter_out_functions.out_string" class="anchored"><td class="def field"><a href="#type-formatter_out_functions.out_string" class="anchor"></a><code>out_string : string <span>-></span> int <span>-></span> int <span>-></span> unit;</code></td></tr><tr id="type-formatter_out_functions.out_flush" class="anchored"><td class="def field"><a href="#type-formatter_out_functions.out_flush" class="anchor"></a><code>out_flush : unit <span>-></span> unit;</code></td></tr><tr id="type-formatter_out_functions.out_newline" class="anchored"><td class="def field"><a href="#type-formatter_out_functions.out_newline" class="anchor"></a><code>out_newline : unit <span>-></span> unit;</code></td></tr><tr id="type-formatter_out_functions.out_spaces" class="anchored"><td class="def field"><a href="#type-formatter_out_functions.out_spaces" class="anchor"></a><code>out_spaces : int <span>-></span> unit;</code></td></tr><tr id="type-formatter_out_functions.out_indent" class="anchored"><td class="def field"><a href="#type-formatter_out_functions.out_indent" class="anchor"></a><code>out_indent : int <span>-></span> unit;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-pp_set_formatter_out_functions"><a href="#val-pp_set_formatter_out_functions" class="anchor"></a><code><span class="keyword">val </span>pp_set_formatter_out_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> <a href="index.html#type-formatter_out_functions">formatter_out_functions</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-set_formatter_out_functions"><a href="#val-set_formatter_out_functions" class="anchor"></a><code><span class="keyword">val </span>set_formatter_out_functions : <a href="index.html#type-formatter_out_functions">formatter_out_functions</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_formatter_out_functions"><a href="#val-pp_get_formatter_out_functions" class="anchor"></a><code><span class="keyword">val </span>pp_get_formatter_out_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> <a href="index.html#type-formatter_out_functions">formatter_out_functions</a></code></dt><dt class="spec value" id="val-get_formatter_out_functions"><a href="#val-get_formatter_out_functions" class="anchor"></a><code><span class="keyword">val </span>get_formatter_out_functions : unit <span>-></span> <a href="index.html#type-formatter_out_functions">formatter_out_functions</a></code></dt></dl><dl><dt class="spec type" id="type-formatter_tag_functions"><a href="#type-formatter_tag_functions" class="anchor"></a><code><span class="keyword">type </span>formatter_tag_functions</code><code><span class="keyword"> = </span>Format.formatter_tag_functions</code><code><span class="keyword"> = </span></code><code>{</code><table class="record"><tr id="type-formatter_tag_functions.mark_open_tag" class="anchored"><td class="def field"><a href="#type-formatter_tag_functions.mark_open_tag" class="anchor"></a><code>mark_open_tag : <a href="index.html#type-tag">tag</a> <span>-></span> string;</code></td></tr><tr id="type-formatter_tag_functions.mark_close_tag" class="anchored"><td class="def field"><a href="#type-formatter_tag_functions.mark_close_tag" class="anchor"></a><code>mark_close_tag : <a href="index.html#type-tag">tag</a> <span>-></span> string;</code></td></tr><tr id="type-formatter_tag_functions.print_open_tag" class="anchored"><td class="def field"><a href="#type-formatter_tag_functions.print_open_tag" class="anchor"></a><code>print_open_tag : <a href="index.html#type-tag">tag</a> <span>-></span> unit;</code></td></tr><tr id="type-formatter_tag_functions.print_close_tag" class="anchored"><td class="def field"><a href="#type-formatter_tag_functions.print_close_tag" class="anchor"></a><code>print_close_tag : <a href="index.html#type-tag">tag</a> <span>-></span> unit;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-pp_set_formatter_tag_functions"><a href="#val-pp_set_formatter_tag_functions" class="anchor"></a><code><span class="keyword">val </span>pp_set_formatter_tag_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> <a href="index.html#type-formatter_tag_functions">formatter_tag_functions</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-set_formatter_tag_functions"><a href="#val-set_formatter_tag_functions" class="anchor"></a><code><span class="keyword">val </span>set_formatter_tag_functions : <a href="index.html#type-formatter_tag_functions">formatter_tag_functions</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_formatter_tag_functions"><a href="#val-pp_get_formatter_tag_functions" class="anchor"></a><code><span class="keyword">val </span>pp_get_formatter_tag_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> <a href="index.html#type-formatter_tag_functions">formatter_tag_functions</a></code></dt><dt class="spec value" id="val-get_formatter_tag_functions"><a href="#val-get_formatter_tag_functions" class="anchor"></a><code><span class="keyword">val </span>get_formatter_tag_functions : unit <span>-></span> <a href="index.html#type-formatter_tag_functions">formatter_tag_functions</a></code></dt><dt class="spec value" id="val-formatter_of_out_channel"><a href="#val-formatter_of_out_channel" class="anchor"></a><code><span class="keyword">val </span>formatter_of_out_channel : Pervasives.out_channel <span>-></span> <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-std_formatter"><a href="#val-std_formatter" class="anchor"></a><code><span class="keyword">val </span>std_formatter : <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-err_formatter"><a href="#val-err_formatter" class="anchor"></a><code><span class="keyword">val </span>err_formatter : <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-formatter_of_buffer"><a href="#val-formatter_of_buffer" class="anchor"></a><code><span class="keyword">val </span>formatter_of_buffer : Buffer.t <span>-></span> <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-stdbuf"><a href="#val-stdbuf" class="anchor"></a><code><span class="keyword">val </span>stdbuf : Buffer.t</code></dt><dt class="spec value" id="val-str_formatter"><a href="#val-str_formatter" class="anchor"></a><code><span class="keyword">val </span>str_formatter : <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-flush_str_formatter"><a href="#val-flush_str_formatter" class="anchor"></a><code><span class="keyword">val </span>flush_str_formatter : unit <span>-></span> string</code></dt><dt class="spec value" id="val-make_formatter"><a href="#val-make_formatter" class="anchor"></a><code><span class="keyword">val </span>make_formatter : (string <span>-></span> int <span>-></span> int <span>-></span> unit) <span>-></span> (unit <span>-></span> unit) <span>-></span> <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-formatter_of_out_functions"><a href="#val-formatter_of_out_functions" class="anchor"></a><code><span class="keyword">val </span>formatter_of_out_functions : <a href="index.html#type-formatter_out_functions">formatter_out_functions</a> <span>-></span> <a href="index.html#type-formatter">formatter</a></code></dt></dl><dl><dt class="spec type" id="type-symbolic_output_item"><a href="#type-symbolic_output_item" class="anchor"></a><code><span class="keyword">type </span>symbolic_output_item</code><code><span class="keyword"> = </span>Format.symbolic_output_item</code><code><span class="keyword"> = </span></code><table class="variant"><tr id="type-symbolic_output_item.Output_flush" class="anchored"><td class="def constructor"><a href="#type-symbolic_output_item.Output_flush" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Output_flush</span></code></td></tr><tr id="type-symbolic_output_item.Output_newline" class="anchored"><td class="def constructor"><a href="#type-symbolic_output_item.Output_newline" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Output_newline</span></code></td></tr><tr id="type-symbolic_output_item.Output_string" class="anchored"><td class="def constructor"><a href="#type-symbolic_output_item.Output_string" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Output_string</span><span class="keyword"> of </span>string</code></td></tr><tr id="type-symbolic_output_item.Output_spaces" class="anchored"><td class="def constructor"><a href="#type-symbolic_output_item.Output_spaces" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Output_spaces</span><span class="keyword"> of </span>int</code></td></tr><tr id="type-symbolic_output_item.Output_indent" class="anchored"><td class="def constructor"><a href="#type-symbolic_output_item.Output_indent" class="anchor"></a><code><span class="keyword">| </span></code><code><span class="constructor">Output_indent</span><span class="keyword"> of </span>int</code></td></tr></table></dt><dt class="spec type" id="type-symbolic_output_buffer"><a href="#type-symbolic_output_buffer" class="anchor"></a><code><span class="keyword">type </span>symbolic_output_buffer</code><code><span class="keyword"> = </span>Format.symbolic_output_buffer</code></dt></dl><dl><dt class="spec value" id="val-make_symbolic_output_buffer"><a href="#val-make_symbolic_output_buffer" class="anchor"></a><code><span class="keyword">val </span>make_symbolic_output_buffer : unit <span>-></span> <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a></code></dt><dt class="spec value" id="val-clear_symbolic_output_buffer"><a href="#val-clear_symbolic_output_buffer" class="anchor"></a><code><span class="keyword">val </span>clear_symbolic_output_buffer : <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-get_symbolic_output_buffer"><a href="#val-get_symbolic_output_buffer" class="anchor"></a><code><span class="keyword">val </span>get_symbolic_output_buffer : <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a> <span>-></span> <a href="index.html#type-symbolic_output_item">symbolic_output_item</a> list</code></dt><dt class="spec value" id="val-flush_symbolic_output_buffer"><a href="#val-flush_symbolic_output_buffer" class="anchor"></a><code><span class="keyword">val </span>flush_symbolic_output_buffer : <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a> <span>-></span> <a href="index.html#type-symbolic_output_item">symbolic_output_item</a> list</code></dt><dt class="spec value" id="val-add_symbolic_output_item"><a href="#val-add_symbolic_output_item" class="anchor"></a><code><span class="keyword">val </span>add_symbolic_output_item : <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a> <span>-></span> <a href="index.html#type-symbolic_output_item">symbolic_output_item</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-formatter_of_symbolic_output_buffer"><a href="#val-formatter_of_symbolic_output_buffer" class="anchor"></a><code><span class="keyword">val </span>formatter_of_symbolic_output_buffer : <a href="index.html#type-symbolic_output_buffer">symbolic_output_buffer</a> <span>-></span> <a href="index.html#type-formatter">formatter</a></code></dt><dt class="spec value" id="val-pp_print_list"><a href="#val-pp_print_list" class="anchor"></a><code><span class="keyword">val </span>pp_print_list : ?⁠pp_sep:(<a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> unit) <span>-></span> (<a href="index.html#type-formatter">formatter</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> unit) <span>-></span> <a href="index.html#type-formatter">formatter</a> <span>-></span> <span class="type-var">'a</span> list <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_print_text"><a href="#val-pp_print_text" class="anchor"></a><code><span class="keyword">val </span>pp_print_text : <a href="index.html#type-formatter">formatter</a> <span>-></span> string <span>-></span> unit</code></dt><dt class="spec value" id="val-fprintf"><a href="#val-fprintf" class="anchor"></a><code><span class="keyword">val </span>fprintf : <a href="index.html#type-formatter">formatter</a> <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-printf"><a href="#val-printf" class="anchor"></a><code><span class="keyword">val </span>printf : (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-eprintf"><a href="#val-eprintf" class="anchor"></a><code><span class="keyword">val </span>eprintf : (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-sprintf"><a href="#val-sprintf" class="anchor"></a><code><span class="keyword">val </span>sprintf : (<span class="type-var">'a</span>, unit, string) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-asprintf"><a href="#val-asprintf" class="anchor"></a><code><span class="keyword">val </span>asprintf : (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit, string) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-ifprintf"><a href="#val-ifprintf" class="anchor"></a><code><span class="keyword">val </span>ifprintf : <a href="index.html#type-formatter">formatter</a> <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-kfprintf"><a href="#val-kfprintf" class="anchor"></a><code><span class="keyword">val </span>kfprintf : (<a href="index.html#type-formatter">formatter</a> <span>-></span> <span class="type-var">'a</span>) <span>-></span> <a href="index.html#type-formatter">formatter</a> <span>-></span> (<span class="type-var">'b</span>, <a href="index.html#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-ikfprintf"><a href="#val-ikfprintf" class="anchor"></a><code><span class="keyword">val </span>ikfprintf : (<a href="index.html#type-formatter">formatter</a> <span>-></span> <span class="type-var">'a</span>) <span>-></span> <a href="index.html#type-formatter">formatter</a> <span>-></span> (<span class="type-var">'b</span>, <a href="index.html#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-ksprintf"><a href="#val-ksprintf" class="anchor"></a><code><span class="keyword">val </span>ksprintf : (string <span>-></span> <span class="type-var">'a</span>) <span>-></span> (<span class="type-var">'b</span>, unit, string, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-kasprintf"><a href="#val-kasprintf" class="anchor"></a><code><span class="keyword">val </span>kasprintf : (string <span>-></span> <span class="type-var">'a</span>) <span>-></span> (<span class="type-var">'b</span>, <a href="index.html#type-formatter">formatter</a>, unit, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-bprintf"><a href="#val-bprintf" class="anchor"></a><code><span class="keyword">val </span>bprintf : Buffer.t <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-formatter">formatter</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dt class="spec value" id="val-kprintf"><a href="#val-kprintf" class="anchor"></a><code><span class="keyword">val </span>kprintf : (string <span>-></span> <span class="type-var">'a</span>) <span>-></span> (<span class="type-var">'b</span>, unit, string, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-set_all_formatter_output_functions"><a href="#val-set_all_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>set_all_formatter_output_functions : out:(string <span>-></span> int <span>-></span> int <span>-></span> unit) <span>-></span> flush:(unit <span>-></span> unit) <span>-></span> newline:(unit <span>-></span> unit) <span>-></span> spaces:(int <span>-></span> unit) <span>-></span> unit</code></dt><dt class="spec value" id="val-get_all_formatter_output_functions"><a href="#val-get_all_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>get_all_formatter_output_functions : unit <span>-></span> (string <span>-></span> int <span>-></span> int <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)<span class="keyword"> * </span>(int <span>-></span> unit)</code></dt><dt class="spec value" id="val-pp_set_all_formatter_output_functions"><a href="#val-pp_set_all_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>pp_set_all_formatter_output_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> out:(string <span>-></span> int <span>-></span> int <span>-></span> unit) <span>-></span> flush:(unit <span>-></span> unit) <span>-></span> newline:(unit <span>-></span> unit) <span>-></span> spaces:(int <span>-></span> unit) <span>-></span> unit</code></dt><dt class="spec value" id="val-pp_get_all_formatter_output_functions"><a href="#val-pp_get_all_formatter_output_functions" class="anchor"></a><code><span class="keyword">val </span>pp_get_all_formatter_output_functions : <a href="index.html#type-formatter">formatter</a> <span>-></span> unit <span>-></span> (string <span>-></span> int <span>-></span> int <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)<span class="keyword"> * </span>(unit <span>-></span> unit)<span class="keyword"> * </span>(int <span>-></span> unit)</code></dt></dl></details></div></div></div><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>Format.formatter</code></dt><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type </span>'a printer</code><code><span class="keyword"> = </span><a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt></dl><section><header><h2 id="combinators"><a href="#combinators" class="anchor"></a>Combinators</h2></header><dl><dt class="spec value" id="val-silent"><a href="#val-silent" class="anchor"></a><code><span class="keyword">val </span>silent : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p>Prints nothing.</p></dd></dl><dl><dt class="spec value" id="val-unit"><a href="#val-unit" class="anchor"></a><code><span class="keyword">val </span>unit : unit <a href="index.html#type-printer">printer</a></code></dt><dd><p>Prints "()".</p></dd></dl><dl><dt class="spec value" id="val-int"><a href="#val-int" class="anchor"></a><code><span class="keyword">val </span>int : int <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-string"><a href="#val-string" class="anchor"></a><code><span class="keyword">val </span>string : string <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-bool"><a href="#val-bool" class="anchor"></a><code><span class="keyword">val </span>bool : bool <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-float3"><a href="#val-float3" class="anchor"></a><code><span class="keyword">val </span>float3 : float <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-float"><a href="#val-float" class="anchor"></a><code><span class="keyword">val </span>float : float <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-newline"><a href="#val-newline" class="anchor"></a><code><span class="keyword">val </span>newline : unit <a href="index.html#type-printer">printer</a></code></dt><dd><p>Force newline (see <span class="xref-unresolved" title="unresolved reference to "Format.pp_force_newline""><code>Format</code>.pp_force_newline</span>).</p><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-substring"><a href="#val-substring" class="anchor"></a><code><span class="keyword">val </span>substring : (string<span class="keyword"> * </span>int<span class="keyword"> * </span>int) <a href="index.html#type-printer">printer</a></code></dt><dd><p>Print 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><dl><dt>raises Invalid_argument</dt><dd><p>if the triple <code>(s,i,len)</code> does not describe a proper substring.</p></dd></dl><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-text"><a href="#val-text" class="anchor"></a><code><span class="keyword">val </span>text : string <a href="index.html#type-printer">printer</a></code></dt><dd><p>Print string, but replacing spaces with breaks and newlines with <a href="index.html#val-newline"><code>newline</code></a>. See <code>pp_print_text</code> on recent versions of OCaml.</p><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-char"><a href="#val-char" class="anchor"></a><code><span class="keyword">val </span>char : char <a href="index.html#type-printer">printer</a></code></dt><dd><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-int32"><a href="#val-int32" class="anchor"></a><code><span class="keyword">val </span>int32 : int32 <a href="index.html#type-printer">printer</a></code></dt><dd><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-int64"><a href="#val-int64" class="anchor"></a><code><span class="keyword">val </span>int64 : int64 <a href="index.html#type-printer">printer</a></code></dt><dd><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-nativeint"><a href="#val-nativeint" class="anchor"></a><code><span class="keyword">val </span>nativeint : nativeint <a href="index.html#type-printer">printer</a></code></dt><dd><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span class="keyword">val </span>flush : unit <a href="index.html#type-printer">printer</a></code></dt><dd><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Format.pp_print_flush""><code>Format</code>.pp_print_flush</span>.</p><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-string_quoted"><a href="#val-string_quoted" class="anchor"></a><code><span class="keyword">val </span>string_quoted : string <a href="index.html#type-printer">printer</a></code></dt><dd><p>Similar to <span class="xref-unresolved" title="unresolved reference to "CCString.print""><a href="../CCString/index.html"><code>CCString</code></a>.print</span>.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-list"><a href="#val-list" class="anchor"></a><code><span class="keyword">val </span>list : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> list <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-array"><a href="#val-array" class="anchor"></a><code><span class="keyword">val </span>array : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> array <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-arrayi"><a href="#val-arrayi" class="anchor"></a><code><span class="keyword">val </span>arrayi : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> (int<span class="keyword"> * </span><span class="type-var">'a</span>) <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> array <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-seq"><a href="#val-seq" class="anchor"></a><code><span class="keyword">val </span>seq : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-opt"><a href="#val-opt" class="anchor"></a><code><span class="keyword">val </span>opt : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> option <a href="index.html#type-printer">printer</a></code></dt><dd><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></dd></dl><aside><p>In the tuple printers, the <code>sep</code> argument is only available.</p><dl><dt>since</dt><dd>0.17</dd></dl></aside><dl><dt class="spec value" id="val-pair"><a href="#val-pair" class="anchor"></a><code><span class="keyword">val </span>pair : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-printer">printer</a> <span>-></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-triple"><a href="#val-triple" class="anchor"></a><code><span class="keyword">val </span>triple : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'c</span> <a href="index.html#type-printer">printer</a> <span>-></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-quad"><a href="#val-quad" class="anchor"></a><code><span class="keyword">val </span>quad : ?⁠sep:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'c</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'d</span> <a href="index.html#type-printer">printer</a> <span>-></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span><span class="keyword"> * </span><span class="type-var">'d</span>) <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-within"><a href="#val-within" class="anchor"></a><code><span class="keyword">val </span>within : string <span>-></span> string <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><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><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-map"><a href="#val-map" class="anchor"></a><code><span class="keyword">val </span>map : (<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>) <span>-></span> <span class="type-var">'b</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dt class="spec value" id="val-vbox"><a href="#val-vbox" class="anchor"></a><code><span class="keyword">val </span>vbox : ?⁠i:int <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p>Wrap the printer in a vertical box.</p><dl><dt>parameter i</dt><dd><p>level of indentation within the box (default 0).</p></dd></dl><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-hvbox"><a href="#val-hvbox" class="anchor"></a><code><span class="keyword">val </span>hvbox : ?⁠i:int <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p>Wrap the printer in a horizontal/vertical box.</p><dl><dt>parameter i</dt><dd><p>level of indentation within the box (default 0).</p></dd></dl><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-hovbox"><a href="#val-hovbox" class="anchor"></a><code><span class="keyword">val </span>hovbox : ?⁠i:int <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p>Wrap the printer in a horizontal or vertical box.</p><dl><dt>parameter i</dt><dd><p>level of indentation within the box (default 0).</p></dd></dl><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-hbox"><a href="#val-hbox" class="anchor"></a><code><span class="keyword">val </span>hbox : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p>Wrap the printer in an horizontal box.</p><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-return"><a href="#val-return" class="anchor"></a><code><span class="keyword">val </span>return : (<span class="type-var">'a</span>, <span class="type-var">_</span>, <span class="type-var">_</span>, <span class="type-var">'a</span>) Pervasives.format4 <span>-></span> unit <a href="index.html#type-printer">printer</a></code></dt><dd><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><dl><dt>since</dt><dd>1.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-of_to_string"><a href="#val-of_to_string" class="anchor"></a><code><span class="keyword">val </span>of_to_string : (<span class="type-var">'a</span> <span>-></span> string) <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><p><code>of_to_string f</code> converts its input to a string using <code>f</code>, then prints the string.</p><dl><dt>since</dt><dd>1.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-const"><a href="#val-const" class="anchor"></a><code><span class="keyword">val </span>const : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> unit <a href="index.html#type-printer">printer</a></code></dt><dd><p><code>const pp x</code> is a unit printer that uses <code>pp</code> on <code>x</code>.</p><dl><dt>since</dt><dd>1.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-some"><a href="#val-some" class="anchor"></a><code><span class="keyword">val </span>some : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> option <a href="index.html#type-printer">printer</a></code></dt><dd><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><dl><dt>since</dt><dd>1.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-lazy_force"><a href="#val-lazy_force" class="anchor"></a><code><span class="keyword">val </span>lazy_force : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> lazy_t <a href="index.html#type-printer">printer</a></code></dt><dd><p><code>lazy_force pp out x</code> forces <code>x</code> and prints the result with <code>pp</code>.</p><dl><dt>since</dt><dd>2.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-lazy_or"><a href="#val-lazy_or" class="anchor"></a><code><span class="keyword">val </span>lazy_or : ?⁠default:unit <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> lazy_t <a href="index.html#type-printer">printer</a></code></dt><dd><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><dl><dt>since</dt><dd>2.0</dd></dl></dd></dl></section><section><header><h2 id="ansi-codes"><a href="#ansi-codes" class="anchor"></a>ANSI codes</h2><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><code class="ml">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><dl><dt>since</dt><dd>0.15</dd></dl></header><dl><dt class="spec value" id="val-set_color_tag_handling"><a href="#val-set_color_tag_handling" class="anchor"></a><code><span class="keyword">val </span>set_color_tag_handling : <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dd><p>Add functions to support color tags to the given formatter.</p><dl><dt>since</dt><dd>0.15</dd></dl></dd></dl><dl><dt class="spec value" id="val-set_color_default"><a href="#val-set_color_default" class="anchor"></a><code><span class="keyword">val </span>set_color_default : bool <span>-></span> unit</code></dt><dd><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="index.html#val-sprintf"><code>sprintf</code></a> formatters; it disables the color handling if <code>b = false</code>.</p></dd></dl><dl><dt class="spec value" id="val-with_color"><a href="#val-with_color" class="anchor"></a><code><span class="keyword">val </span>with_color : string <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></dt><dd><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><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-with_colorf"><a href="#val-with_colorf" class="anchor"></a><code><span class="keyword">val </span>with_colorf : string <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, unit) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p><code>with_colorf "Blue" out "%s %d" "yolo" 42</code> will behave like <span class="xref-unresolved" title="unresolved reference to "Format.fprintf""><code>Format</code>.fprintf</span>, but wrapping the content with the given style.</p><p><b>status: unstable</b></p><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-with_color_sf"><a href="#val-with_color_sf" class="anchor"></a><code><span class="keyword">val </span>with_color_sf : string <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, string) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p><code>with_color_sf "Blue" out "%s %d" "yolo" 42</code> will behave like <a href="index.html#val-sprintf"><code>sprintf</code></a>, but wrapping the content with the given style.</p><p>Example:</p><pre><code class="ml">CCFormat.with_color_sf "red" "%a" CCFormat.Dump.(list int) [1;2;3] |> print_endline;;</code></pre><p><b>status: unstable</b></p><dl><dt>since</dt><dd>0.21</dd></dl></dd></dl><dl><dt class="spec value" id="val-with_color_ksf"><a href="#val-with_color_ksf" class="anchor"></a><code><span class="keyword">val </span>with_color_ksf : f:(string <span>-></span> <span class="type-var">'b</span>) <span>-></span> string <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, <span class="type-var">'b</span>) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p><code>with_color_ksf "Blue" ~f "%s %d" "yolo" 42</code> will behave like <a href="index.html#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><code class="ml">CCFormat.with_color_ksf "red" ~f:failwith "%a" CCFormat.Dump.(list int) [1;2;3];;</code></pre><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl></section><section><header><h2 id="io"><a href="#io" class="anchor"></a>IO</h2></header><dl><dt class="spec value" id="val-output"><a href="#val-output" class="anchor"></a><code><span class="keyword">val </span>output : <a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val </span>to_string : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> string</code></dt><dt class="spec value" id="val-of_chan"><a href="#val-of_chan" class="anchor"></a><code><span class="keyword">val </span>of_chan : Pervasives.out_channel <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Format.formatter_of_out_channel""><code>Format</code>.formatter_of_out_channel</span>.</p><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-with_out_chan"><a href="#val-with_out_chan" class="anchor"></a><code><span class="keyword">val </span>with_out_chan : Pervasives.out_channel <span>-></span> (<a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span>) <span>-></span> <span class="type-var">'a</span></code></dt><dd><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><dl><dt>since</dt><dd>1.2</dd></dl></dd></dl><dl><dt class="spec value" id="val-stdout"><a href="#val-stdout" class="anchor"></a><code><span class="keyword">val </span>stdout : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-stderr"><a href="#val-stderr" class="anchor"></a><code><span class="keyword">val </span>stderr : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-tee"><a href="#val-tee" class="anchor"></a><code><span class="keyword">val </span>tee : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>tee a b</code> makes a new formatter that writes in both <code>a</code> and <code>b</code>.</p><dl><dt>since</dt><dd>1.0</dd></dl></dd></dl><dl><dt class="spec value" id="val-sprintf"><a href="#val-sprintf" class="anchor"></a><code><span class="keyword">val </span>sprintf : (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, string) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Print into a string any format string that would usually be compatible with <a href="index.html#val-fprintf"><code>fprintf</code></a>. Like <span class="xref-unresolved" title="unresolved reference to "Format.asprintf""><code>Format</code>.asprintf</span>.</p></dd></dl><dl><dt class="spec value" id="val-sprintf_no_color"><a href="#val-sprintf_no_color" class="anchor"></a><code><span class="keyword">val </span>sprintf_no_color : (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, string) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Like <a href="index.html#val-sprintf"><code>sprintf</code></a> but never prints colors.</p><dl><dt>since</dt><dd>0.16</dd></dl></dd></dl><dl><dt class="spec value" id="val-sprintf_dyn_color"><a href="#val-sprintf_dyn_color" class="anchor"></a><code><span class="keyword">val </span>sprintf_dyn_color : colors:bool <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, string) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Like <a href="index.html#val-sprintf"><code>sprintf</code></a> but enable/disable colors depending on <code>colors</code>.</p><p>Example:</p><pre><code class="ml">(* 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><dl><dt>since</dt><dd>0.21</dd></dl></dd></dl><dl><dt class="spec value" id="val-fprintf"><a href="#val-fprintf" class="anchor"></a><code><span class="keyword">val </span>fprintf : <a href="index.html#type-t">t</a> <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Format.fprintf""><code>Format</code>.fprintf</span>.</p><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-fprintf_dyn_color"><a href="#val-fprintf_dyn_color" class="anchor"></a><code><span class="keyword">val </span>fprintf_dyn_color : colors:bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit) Pervasives.format <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Like <a href="index.html#val-fprintf"><code>fprintf</code></a> but enable/disable colors depending on <code>colors</code>.</p><dl><dt>since</dt><dd>0.21</dd></dl></dd></dl><dl><dt class="spec value" id="val-ksprintf"><a href="#val-ksprintf" class="anchor"></a><code><span class="keyword">val </span>ksprintf : ?⁠margin:int <span>-></span> f:(string <span>-></span> <span class="type-var">'b</span>) <span>-></span> (<span class="type-var">'a</span>, Format.formatter, unit, <span class="type-var">'b</span>) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p><code>ksprintf fmt ~f</code> formats using <code>fmt</code>, in a way similar to <a href="index.html#val-sprintf"><code>sprintf</code></a>, and then calls <code>f</code> on the resulting string.</p><dl><dt>parameter margin</dt><dd><p>set margin (since 2.1)</p></dd></dl><dl><dt>since</dt><dd>0.14</dd></dl></dd></dl><dl><dt class="spec value" id="val-to_file"><a href="#val-to_file" class="anchor"></a><code><span class="keyword">val </span>to_file : string <span>-></span> (<span class="type-var">'a</span>, <a href="index.html#type-t">t</a>, unit, unit) Pervasives.format4 <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Print to the given file.</p></dd></dl></section><section><header><h2 id="dump"><a href="#dump" class="anchor"></a>Dump</h2><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><code class="ml">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><dl><dt>since</dt><dd>0.21</dd></dl></header><div class="spec module" id="module-Dump"><a href="#module-Dump" class="anchor"></a><code><span class="keyword">module </span><a href="Dump/index.html">Dump</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div></section></div></body></html> |