ocaml-opentelemetry/sexplib0/Sexplib0/Sexp_conv_record/index.html
2025-01-31 01:39:34 +00:00

17 lines
4.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sexp_conv_record (sexplib0.Sexplib0.Sexp_conv_record)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">sexplib0</a> &#x00BB; <a href="../index.html">Sexplib0</a> &#x00BB; Sexp_conv_record</nav><header class="odoc-preamble"><h1>Module <code><span>Sexplib0.Sexp_conv_record</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Kind"><a href="#module-Kind" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Kind/index.html">Kind</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Fields"><a href="#module-Fields" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fields/index.html">Fields</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record_of_sexp"><a href="#val-record_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> record_of_sexp :
<span><span class="label">caller</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">fields</span>:<span><span class="type-var">'a</span> <a href="Fields/index.html#type-t">Fields.t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">index_of_field</span>:<span>(<span>string <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">allow_extra_fields</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">create</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../Sexp/index.html#type-t">Sexp.t</a> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'b</span></span></code></div><div class="spec-doc"><p>Parses a record from a sexp that must be a list of fields.</p><p>Uses <code>caller</code> as the source for error messages. Parses using the given <code>field</code>s. Uses <code>index_of_field</code> to look up field names found in sexps. If <code>allow_extra_fields</code> is true, extra fields are allowed and discarded without error. <code>create</code> is used to construct the final returned value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-record_of_sexps"><a href="#val-record_of_sexps" class="anchor"></a><code><span><span class="keyword">val</span> record_of_sexps :
<span><span class="label">caller</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">context</span>:<a href="../Sexp/index.html#type-t">Sexp.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">fields</span>:<span><span class="type-var">'a</span> <a href="Fields/index.html#type-t">Fields.t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">index_of_field</span>:<span>(<span>string <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">allow_extra_fields</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">create</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="../Sexp/index.html#type-t">Sexp.t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'b</span></span></code></div><div class="spec-doc"><p>Like <code>record_of_sexp</code>, but for a list of sexps with no <code>List</code> wrapper. Used, for example, to parse arguments to a variant constructor with an inlined record argument. Reports <code>context</code> for parse errors when no more specific sexp is applicable.</p></div></div></div></body></html>