mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
4 lines
No EOL
14 KiB
HTML
4 lines
No EOL
14 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers.CCCanonical_sexp.Make)</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> » <a href="../index.html">CCCanonical_sexp</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>CCCanonical_sexp.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parser-and-printer">Parser and printer</a></li><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a><ul><li><a href="#re-exports">Re-exports</a></li><li><a href="#constructors">Constructors</a></li><li><a href="#printing">Printing</a></li><li><a href="#parsing">Parsing</a></li></ul></li></ul></nav><div class="odoc-content"><h3 id="parser-and-printer"><a href="#parser-and-printer" class="anchor"></a>Parser and printer</h3><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Sexp"><a href="#argument-1-Sexp" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Sexp/index.html">Sexp</a></span><span> : <a href="../../CCSexp_intf/module-type-BASIC_SEXP/index.html">SEXP</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><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> = <a href="argument-1-Sexp/index.html#type-t">Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-sexp"><a href="#type-sexp" class="anchor"></a><code><span><span class="keyword">type</span> sexp</span><span> = <a href="#type-t">t</a></span></code></div></div><h3 id="re-exports"><a href="#re-exports" class="anchor"></a>Re-exports</h3><div class="odoc-spec"><div class="spec value anchored" id="val-atom"><a href="#val-atom" class="anchor"></a><code><span><span class="keyword">val</span> atom : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make an atom out of this string.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.8</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><span><a href="#type-t">t</a> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make a Sexpr of this list.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.8</li></ul></div></div><h3 id="constructors"><a href="#constructors" class="anchor"></a>Constructors</h3><div class="odoc-spec"><div class="spec value anchored" id="val-of_int"><a href="#val-of_int" class="anchor"></a><code><span><span class="keyword">val</span> of_int : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_bool"><a href="#val-of_bool" class="anchor"></a><code><span><span class="keyword">val</span> of_bool : <span>bool <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_list"><a href="#val-of_list" class="anchor"></a><code><span><span class="keyword">val</span> of_list : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_rev_list"><a href="#val-of_rev_list" class="anchor"></a><code><span><span class="keyword">val</span> of_rev_list : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Reverse the list.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_float"><a href="#val-of_float" class="anchor"></a><code><span><span class="keyword">val</span> of_float : <span>float <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_unit"><a href="#val-of_unit" class="anchor"></a><code><span><span class="keyword">val</span> of_unit : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_pair"><a href="#val-of_pair" class="anchor"></a><code><span><span class="keyword">val</span> of_pair : <span><span>(<a href="#type-t">t</a> * <a href="#type-t">t</a>)</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_triple"><a href="#val-of_triple" class="anchor"></a><code><span><span class="keyword">val</span> of_triple : <span><span>(<a href="#type-t">t</a> * <a href="#type-t">t</a> * <a href="#type-t">t</a>)</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_quad"><a href="#val-of_quad" class="anchor"></a><code><span><span class="keyword">val</span> of_quad : <span><span>(<a href="#type-t">t</a> * <a href="#type-t">t</a> * <a href="#type-t">t</a> * <a href="#type-t">t</a>)</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_variant"><a href="#val-of_variant" class="anchor"></a><code><span><span class="keyword">val</span> of_variant : <span>string <span class="arrow">-></span></span> <span><span><a href="#type-t">t</a> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>of_variant name args</code> is used to encode algebraic variants into a S-expr. For instance <code>of_variant "some" [of_int 1]</code> represents the value <code>Some 1</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_field"><a href="#val-of_field" class="anchor"></a><code><span><span class="keyword">val</span> of_field : <span>string <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>Used to represent one record field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_record"><a href="#val-of_record" class="anchor"></a><code><span><span class="keyword">val</span> of_record : <span><span><span>(string * <a href="#type-t">t</a>)</span> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Represent a record by its named fields.</p></div></div><h3 id="printing"><a href="#printing" class="anchor"></a>Printing</h3><div class="odoc-spec"><div class="spec value anchored" id="val-to_buf"><a href="#val-to_buf" class="anchor"></a><code><span><span class="keyword">val</span> to_buf : <span><span class="xref-unresolved">Stdlib</span>.Buffer.t <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <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><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></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><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_file_iter"><a href="#val-to_file_iter" class="anchor"></a><code><span><span class="keyword">val</span> to_file_iter : <span>string <span class="arrow">-></span></span> <span><span><a href="#type-t">t</a> <a href="../../CCSexp_intf/index.html#type-iter">CCSexp_intf.iter</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print the given iter of expressions to a file.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_chan"><a href="#val-to_chan" class="anchor"></a><code><span><span class="keyword">val</span> to_chan : <span><span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Pretty-printer nice on human eyes (including indentation).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_noindent"><a href="#val-pp_noindent" class="anchor"></a><code><span><span class="keyword">val</span> pp_noindent : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Raw, direct printing as compact as possible.</p></div></div><h3 id="parsing"><a href="#parsing" class="anchor"></a>Parsing</h3><div class="odoc-spec"><div class="spec value anchored" id="val-parse_string"><a href="#val-parse_string" class="anchor"></a><code><span><span class="keyword">val</span> parse_string : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div><div class="spec-doc"><p>Parse a string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_string_list"><a href="#val-parse_string_list" class="anchor"></a><code><span><span class="keyword">val</span> parse_string_list : <span>string <span class="arrow">-></span></span> <span><span><a href="#type-t">t</a> list</span> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div><div class="spec-doc"><p>Parse a string into a list of S-exprs.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.8</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_chan"><a href="#val-parse_chan" class="anchor"></a><code><span><span class="keyword">val</span> parse_chan : <span><span class="xref-unresolved">Stdlib</span>.in_channel <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div><div class="spec-doc"><p>Parse a S-expression from the given channel. Can read more data than necessary, so don't use this if you need finer-grained control (e.g. to read something else <b>after</b> the S-exp).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_chan_gen"><a href="#val-parse_chan_gen" class="anchor"></a><code><span><span class="keyword">val</span> parse_chan_gen :
|
||
<span><span class="xref-unresolved">Stdlib</span>.in_channel <span class="arrow">-></span></span>
|
||
<span><span><a href="#type-t">t</a> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span> <a href="../../CCSexp_intf/index.html#type-gen">CCSexp_intf.gen</a></span></span></code></div><div class="spec-doc"><p>Parse a channel into a generator of S-expressions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_chan_list"><a href="#val-parse_chan_list" class="anchor"></a><code><span><span class="keyword">val</span> parse_chan_list : <span><span class="xref-unresolved">Stdlib</span>.in_channel <span class="arrow">-></span></span> <span><span><a href="#type-t">t</a> list</span> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_file"><a href="#val-parse_file" class="anchor"></a><code><span><span class="keyword">val</span> parse_file : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div><div class="spec-doc"><p>Open the file and read a S-exp from it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_file_list"><a href="#val-parse_file_list" class="anchor"></a><code><span><span class="keyword">val</span> parse_file_list : <span>string <span class="arrow">-></span></span> <span><span><a href="#type-t">t</a> list</span> <a href="../../CCSexp_intf/index.html#type-or_error">CCSexp_intf.or_error</a></span></span></code></div><div class="spec-doc"><p>Open the file and read a S-exp from it.</p></div></div></div></body></html> |