mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-07 18:37:56 -05:00
19 lines
13 KiB
HTML
19 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pp (pbrt.Pbrt.Pp)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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">Index</a> » <a href="../../index.html">pbrt</a> » <a href="../index.html">Pbrt</a> » Pp</nav><header class="odoc-preamble"><h1>Module <code><span>Pbrt.Pp</span></code></h1><p>Runtime functions for Pretty Printing functionality</p></header><div class="odoc-content"><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> = <a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_unit"><a href="#val-pp_unit" class="anchor"></a><code><span><span class="keyword">val</span> pp_unit : <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"><p><code>pp_unit fmt ()</code> formats <code>unit</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_int"><a href="#val-pp_int" class="anchor"></a><code><span><span class="keyword">val</span> pp_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 class="spec-doc"><p><code>pp_unit fmt i</code> formats <code>i</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_float"><a href="#val-pp_float" class="anchor"></a><code><span><span class="keyword">val</span> pp_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 class="spec-doc"><p><code>pp_unit fmt f</code> formats <code>f</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_bool"><a href="#val-pp_bool" class="anchor"></a><code><span><span class="keyword">val</span> pp_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 class="spec-doc"><p><code>pp_unit fmt b</code> formats <code>b</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_int32"><a href="#val-pp_int32" class="anchor"></a><code><span><span class="keyword">val</span> pp_int32 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_unit fmt i</code> formats <code>i</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_unsigned_of_int32"><a href="#val-pp_unsigned_of_int32" class="anchor"></a><code><span><span class="keyword">val</span> pp_unsigned_of_int32 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>[ <span>`unsigned of int32</span> ]</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_int64"><a href="#val-pp_int64" class="anchor"></a><code><span><span class="keyword">val</span> pp_int64 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span>int64 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_unit fmt i</code> formats <code>i</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_unsigned_of_int64"><a href="#val-pp_unsigned_of_int64" class="anchor"></a><code><span><span class="keyword">val</span> pp_unsigned_of_int64 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>[ <span>`unsigned of int64</span> ]</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_string"><a href="#val-pp_string" class="anchor"></a><code><span><span class="keyword">val</span> pp_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 class="spec-doc"><p><code>pp_unit fmt s</code> formats <code>s</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_bytes"><a href="#val-pp_bytes" class="anchor"></a><code><span><span class="keyword">val</span> pp_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 class="spec-doc"><p><code>pp_unit fmt b</code> formats <code>b</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_option"><a href="#val-pp_option" class="anchor"></a><code><span><span class="keyword">val</span> pp_option : <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 class="spec-doc"><p><code>pp_option f fmt o</code> formats an option value <code>o</code> using <code>f</code> formatter when <code>o</code> is a <code>Some x</code> value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_float"><a href="#val-pp_wrapper_float" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_float : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>float option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_bool"><a href="#val-pp_wrapper_bool" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_bool : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>bool option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_int32"><a href="#val-pp_wrapper_int32" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_int32 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>int32 option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_int64"><a href="#val-pp_wrapper_int64" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_int64 : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>int64 option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_string"><a href="#val-pp_wrapper_string" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_string : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>string option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_wrapper_bytes"><a href="#val-pp_wrapper_bytes" class="anchor"></a><code><span><span class="keyword">val</span> pp_wrapper_bytes : <span><a href="#type-formatter">formatter</a> <span class="arrow">-></span></span> <span><span>bytes option</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_list"><a href="#val-pp_list" class="anchor"></a><code><span><span class="keyword">val</span> pp_list : <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 class="spec-doc"><p><code>pp_list f fmt l</code> formats a list value <code>l</code> using <code>f</code> formatter on each of the elements.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_associative_list"><a href="#val-pp_associative_list" class="anchor"></a><code><span><span class="keyword">val</span> pp_associative_list :
|
||
<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><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> list</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_hastable"><a href="#val-pp_hastable" class="anchor"></a><code><span><span class="keyword">val</span> pp_hastable :
|
||
<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><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> <a href="../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Stdlib.Hashtbl.t</a></span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_record_field"><a href="#val-pp_record_field" class="anchor"></a><code><span><span class="keyword">val</span> pp_record_field :
|
||
<span><span class="optlabel">?absent</span>:bool <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?first</span>:bool <span class="arrow">-></span></span>
|
||
<span>string <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 class="type-var">'a</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_record_field label_name fmt field_value</code> formats a record <code>field_value</code> with <code>label_name</code></p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">absent</span> <p>if true, a comment <code>"(* absent *)"</code> is emitted. since NEXT_RELEASE</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_brk"><a href="#val-pp_brk" class="anchor"></a><code><span><span class="keyword">val</span> pp_brk : <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 class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_brk fmt r</code> formats record value <code>r</code> with curly brakets.</p></div></div></div></body></html>
|