mirror of
https://github.com/c-cube/linol.git
synced 2025-12-11 05:28:35 -05:00
14 lines
7 KiB
HTML
14 lines
7 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Conv (cmdliner.Cmdliner.Arg.Conv)</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">cmdliner</a> » <a href="../../index.html">Cmdliner</a> » <a href="../index.html">Arg</a> » Conv</nav><header class="odoc-preamble"><h1>Module <code><span>Arg.Conv</span></code></h1><p>Argument converters.</p><p>An argument converter transforms a string argument of the command line to an OCaml value. <a href="../index.html#converters" title="converters">Predefined converters</a> are provided for many types of the standard library.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#converters">Converters</a></li><li><a href="#properties">Properties</a></li></ul></nav></div><div class="odoc-content"><h2 id="converters"><a href="#converters" class="anchor"></a>Converters</h2><div class="odoc-spec"><div class="spec type anchored" id="type-parser"><a href="#type-parser" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a parser</span></span><span> = <span>string <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, string)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span></span></code></div><div class="spec-doc"><p>The type for parsing arguments to values of type <code>'a</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-fmt"><a href="#type-fmt" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a fmt</span></span><span> = <span><a href="../../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.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>The type for formatting values of type <code>'a</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div><div class="spec-doc"><p>The type for converting arguments to values of type <code>'a</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||
<span><span class="optlabel">?completion</span>:<span><span class="type-var">'a</span> <a href="../Completion/index.html#type-t">Completion.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="label">docv</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">parser</span>:<span><span class="type-var">'a</span> <a href="#type-parser">parser</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="label">pp</span>:<span><span class="type-var">'a</span> <a href="#type-fmt">fmt</a></span> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>make ~docv ~parser ~pp ()</code> is an argument converter with given properties. See corresponding accessors for semantics.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_conv"><a href="#val-of_conv" class="anchor"></a><code><span><span class="keyword">val</span> of_conv :
|
||
<span><span class="optlabel">?completion</span>:<span><span class="type-var">'a</span> <a href="../Completion/index.html#type-t">Completion.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?docv</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?parser</span>:<span><span class="type-var">'a</span> <a href="#type-parser">parser</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?pp</span>:<span><span class="type-var">'a</span> <a href="#type-fmt">fmt</a></span> <span class="arrow">-></span></span>
|
||
<span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>of_conv conv ()</code> is a new converter with given unspecified properties defaulting to those of <code>conv</code>.</p></div></div><h2 id="properties"><a href="#properties" class="anchor"></a>Properties</h2><div class="odoc-spec"><div class="spec value anchored" id="val-docv"><a href="#val-docv" class="anchor"></a><code><span><span class="keyword">val</span> docv : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>docv c</code> is <code>c</code>'s documentation meta-variable. This value can be refered to as <code>$(docv)</code> in the documentation strings of arguments. It can be overriden by the <a href="../index.html#val-info"><code>info</code></a> value of an argument.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parser"><a href="#val-parser" class="anchor"></a><code><span><span class="keyword">val</span> parser : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-parser">parser</a></span></span></code></div><div class="spec-doc"><p><code>parser c</code> is <code>c</code>'s argument parser.</p></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><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-fmt">fmt</a></span></span></code></div><div class="spec-doc"><p><code>pp c</code> is <code>c</code>'s argument formatter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-completion"><a href="#val-completion" class="anchor"></a><code><span><span class="keyword">val</span> completion : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../Completion/index.html#type-t">Completion.t</a></span></span></code></div><div class="spec-doc"><p><code>completion c</code> is <code>c</code>'s completion.</p></div></div></div></body></html>
|