linol/lsp/Lsp/Cli/Arg/index.html
2025-01-10 16:49:28 +00:00

2 lines
2.9 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>Arg (lsp.Lsp.Cli.Arg)</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">lsp</a> &#x00BB; <a href="../../index.html">Lsp</a> &#x00BB; <a href="../index.html">Cli</a> &#x00BB; Arg</nav><header class="odoc-preamble"><h1>Module <code><span>Cli.Arg</span></code></h1><p>Parsing of the standard commnad line arguments using <code>Stdlib.Arg</code></p></header><div class="odoc-content"><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></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> create a new record for arguments</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-spec"><a href="#val-spec" class="anchor"></a><code><span><span class="keyword">val</span> spec : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>(string * <a href="../../../../ocaml/Stdlib/Arg/index.html#type-spec">Stdlib.Arg.spec</a> * string)</span> list</span></span></code></div><div class="spec-doc"><p><code>spec t</code> returns the spec that should be provided to <code>Stdlib.Arg</code> to populate <code>t</code> using the interpreted cli args</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-channel"><a href="#val-channel" class="anchor"></a><code><span><span class="keyword">val</span> channel : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="../Channel/index.html#type-t">Channel.t</a>, string)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span></span></code></div><div class="spec-doc"><p><code>channel t</code> return the channel if correctly supplied. An error if the arguments were provided incorrectly.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-clientProcessId"><a href="#val-clientProcessId" class="anchor"></a><code><span><span class="keyword">val</span> clientProcessId : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int option</span></span></code></div><div class="spec-doc"><p>Return the process id of the client used to run the lsp server if it was provided</p></div></div></div></body></html>