mirror of
https://github.com/c-cube/linol.git
synced 2026-01-21 08:56:40 -05:00
deploy: a63ac9b5cb
This commit is contained in:
c-cube
parent
86ab61b843
commit
66c6c9c55b
1757 changed files with 3056 additions and 2827 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Arg (cmdliner.Cmdliner.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">cmdliner</a> » <a href="../index.html">Cmdliner</a> » Arg</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner.Arg</span></code></h1><p>Terms for command line arguments.</p><p>This module provides functions to define terms that evaluate to the arguments provided on the command line.</p><p>Basic constraints, like the argument type or repeatability, are specified by defining a value of type <a href="#type-t"><code>Arg.t</code></a>. Further constraints can be specified during the <a href="#argterms" title="argterms">conversion</a> to a term.</p></header><nav class="odoc-toc"><ul><li><a href="#argconv">Argument converters</a></li><li><a href="#arginfo">Arguments and their information</a></li><li><a href="#optargs">Optional arguments</a></li><li><a href="#posargs">Positional arguments</a></li><li><a href="#argterms">Arguments as terms</a></li><li><a href="#predef">Predefined arguments</a></li><li><a href="#converters">Predefined converters</a></li><li><a href="#doc_helpers">Documentation formatting helpers</a></li><li><a href="#deprecated">Deprecated</a></li></ul></nav><div class="odoc-content"><h2 id="argconv"><a href="#argconv" class="anchor"></a>Argument converters</h2><p>An argument converter transforms a string argument of the command line to an OCaml value. <a href="#converters" title="converters">Predefined converters</a> are provided for many types of the standard library.</p><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>`Ok of <span class="type-var">'a</span></span> <span><span>| `Error</span> of string</span> ]</span></span></code></div><div class="spec-doc"><p>The type for argument parsers.</p><p><b>Deprecated.</b> Use parser signatures of <a href="#val-conv"><code>conv</code></a> or <a href="#val-conv'"><code>conv'</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Arg.conv or Arg.conv' instead.</li></ul></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a printer</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 converted argument printers.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-conv"><a href="#type-conv" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a conv</span></span><span> = <span><span class="type-var">'a</span> <a href="#type-parser">parser</a></span> * <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>The type for argument converters.</p><p><b>Warning.</b> Do not use directly, use <a href="#val-conv"><code>conv</code></a> or <a href="#val-conv'"><code>conv'</code></a>. This type will become abstract in the next major version of cmdliner.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-conv"><a href="#val-conv" class="anchor"></a><code><span><span class="keyword">val</span> conv :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Arg (cmdliner.Cmdliner.Arg)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » Arg</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner.Arg</span></code></h1><p>Terms for command line arguments.</p><p>This module provides functions to define terms that evaluate to the arguments provided on the command line.</p><p>Basic constraints, like the argument type or repeatability, are specified by defining a value of type <a href="#type-t"><code>Arg.t</code></a>. Further constraints can be specified during the <a href="#argterms" title="argterms">conversion</a> to a term.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#argconv">Argument converters</a></li><li><a href="#arginfo">Arguments and their information</a></li><li><a href="#optargs">Optional arguments</a></li><li><a href="#posargs">Positional arguments</a></li><li><a href="#argterms">Arguments as terms</a></li><li><a href="#predef">Predefined arguments</a></li><li><a href="#converters">Predefined converters</a></li><li><a href="#doc_helpers">Documentation formatting helpers</a></li><li><a href="#deprecated">Deprecated</a></li></ul></nav></div><div class="odoc-content"><h2 id="argconv"><a href="#argconv" class="anchor"></a>Argument converters</h2><p>An argument converter transforms a string argument of the command line to an OCaml value. <a href="#converters" title="converters">Predefined converters</a> are provided for many types of the standard library.</p><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>`Ok of <span class="type-var">'a</span></span> <span><span>| `Error</span> of string</span> ]</span></span></code></div><div class="spec-doc"><p>The type for argument parsers.</p><p><b>Deprecated.</b> Use parser signatures of <a href="#val-conv"><code>conv</code></a> or <a href="#val-conv'"><code>conv'</code></a>.</p><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> Use Arg.conv or Arg.conv' instead.</li></ul></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a printer</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 converted argument printers.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-conv"><a href="#type-conv" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a conv</span></span><span> = <span><span class="type-var">'a</span> <a href="#type-parser">parser</a></span> * <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span></span></code></div><div class="spec-doc"><p>The type for argument converters.</p><p><b>Warning.</b> Do not use directly, use <a href="#val-conv"><code>conv</code></a> or <a href="#val-conv'"><code>conv'</code></a>. This type will become abstract in the next major version of cmdliner.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-conv"><a href="#val-conv" class="anchor"></a><code><span><span class="keyword">val</span> conv :
|
||||
<span><span class="optlabel">?docv</span>:string <span class="arrow">-></span></span>
|
||||
<span><span>(<span>(<span>string <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span>[ <span>`Msg of string</span> ]</span>)</span> <a href="../../../ocaml/Stdlib/index.html#type-result">result</a></span>)</span> * <span><span class="type-var">'a</span> <a href="#type-printer">printer</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'a</span> <a href="#type-conv">conv</a></span></span></code></div><div class="spec-doc"><p><code>conv ~docv (parse, print)</code> is an argument converter parsing values with <code>parse</code> and printing them with <code>print</code>. <code>docv</code> is a documentation meta-variable used in the documentation to stand for the argument value, defaults to <code>"VALUE"</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-conv'"><a href="#val-conv'" class="anchor"></a><code><span><span class="keyword">val</span> conv' :
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Env (cmdliner.Cmdliner.Cmd.Env)</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">cmdliner</a> » <a href="../../index.html">Cmdliner</a> » <a href="../index.html">Cmd</a> » Env</nav><header class="odoc-preamble"><h1>Module <code><span>Cmd.Env</span></code></h1><p>Environment variable and their information.</p></header><nav class="odoc-toc"><ul><li><a href="#envvars">Environment variables</a></li><li><a href="#info">Environment variable information</a></li></ul></nav><div class="odoc-content"><h2 id="envvars"><a href="#envvars" class="anchor"></a>Environment variables</h2><div class="odoc-spec"><div class="spec type anchored" id="type-var"><a href="#type-var" class="anchor"></a><code><span><span class="keyword">type</span> var</span><span> = string</span></code></div><div class="spec-doc"><p>The type for environment names.</p></div></div><h2 id="info"><a href="#info" class="anchor"></a>Environment variable information</h2><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span><span> = <a href="../../Term/index.html#type-env_info">Term.env_info</a></span></code></div><div class="spec-doc"><p>The type for environment variable information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="optlabel">?deprecated</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?docs</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?doc</span>:string <span class="arrow">-></span></span> <span><a href="#type-var">var</a> <span class="arrow">-></span></span> <a href="#type-info">info</a></span></code></div><div class="spec-doc"><p><code>info ~docs ~doc var</code> describes an environment variable <code>var</code> such that:</p><ul><li><code>doc</code> is the man page information of the environment variable, defaults to <code>"undocumented"</code>.</li><li><code>docs</code> is the title of the man page section in which the environment variable will be listed, it defaults to <a href="../../Manpage/index.html#val-s_environment"><code>Cmdliner.Manpage.s_environment</code></a>.</li><li><code>deprecated</code>, if specified the environment is deprecated and the string is a message output on standard error when the environment variable gets used to lookup the default value of an argument.</li></ul><p>In <code>doc</code> the <a href="../../../tool_man.html#doclang" title="doclang">documentation markup language</a> can be used with following variables:</p><ul><li><code>$(env)</code>, the value of <code>var</code>.</li><li>The variables mentioned in <a href="#val-info"><code>info</code></a>.</li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Env (cmdliner.Cmdliner.Cmd.Env)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">Cmd</a> » Env</nav><header class="odoc-preamble"><h1>Module <code><span>Cmd.Env</span></code></h1><p>Environment variable and their information.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#envvars">Environment variables</a></li><li><a href="#info">Environment variable information</a></li></ul></nav></div><div class="odoc-content"><h2 id="envvars"><a href="#envvars" class="anchor"></a>Environment variables</h2><div class="odoc-spec"><div class="spec type anchored" id="type-var"><a href="#type-var" class="anchor"></a><code><span><span class="keyword">type</span> var</span><span> = string</span></code></div><div class="spec-doc"><p>The type for environment names.</p></div></div><h2 id="info"><a href="#info" class="anchor"></a>Environment variable information</h2><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span><span> = <a href="../../Term/index.html#type-env_info">Term.env_info</a></span></code></div><div class="spec-doc"><p>The type for environment variable information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="optlabel">?deprecated</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?docs</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?doc</span>:string <span class="arrow">-></span></span> <span><a href="#type-var">var</a> <span class="arrow">-></span></span> <a href="#type-info">info</a></span></code></div><div class="spec-doc"><p><code>info ~docs ~doc var</code> describes an environment variable <code>var</code> such that:</p><ul><li><code>doc</code> is the man page information of the environment variable, defaults to <code>"undocumented"</code>.</li><li><code>docs</code> is the title of the man page section in which the environment variable will be listed, it defaults to <a href="../../Manpage/index.html#val-s_environment"><code>Cmdliner.Manpage.s_environment</code></a>.</li><li><code>deprecated</code>, if specified the environment is deprecated and the string is a message output on standard error when the environment variable gets used to lookup the default value of an argument.</li></ul><p>In <code>doc</code> the <a href="../../../tool_man.html#doclang" title="doclang">documentation markup language</a> can be used with following variables:</p><ul><li><code>$(env)</code>, the value of <code>var</code>.</li><li>The variables mentioned in <a href="#val-info"><code>info</code></a>.</li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmd (cmdliner.Cmdliner.Cmd)</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">cmdliner</a> » <a href="../index.html">Cmdliner</a> » Cmd</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner.Cmd</span></code></h1><p>Commands.</p><p>Command line syntaxes are implicitely defined by <a href="../Term/index.html"><code>Term</code></a>s. A command value binds a syntax and its documentation to a command name.</p><p>A command can group a list of sub commands (and recursively). In this case your tool defines a tree of commands, each with its own command line syntax. The root of that tree is called the <em>main command</em>; it represents your tool and its name.</p></header><nav class="odoc-toc"><ul><li><a href="#info">Command information</a></li><li><a href="#cmds">Commands</a></li><li><a href="#eval">Evaluation</a><ul><li><a href="#eval_low">Low level evaluation</a></li></ul></li></ul></nav><div class="odoc-content"><h2 id="info"><a href="#info" class="anchor"></a>Command information</h2><p>Command information defines the name and documentation of a command.</p><div class="odoc-spec"><div class="spec module anchored" id="module-Exit"><a href="#module-Exit" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exit/index.html">Exit</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Exit codes and their information.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Env"><a href="#module-Env" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Env/index.html">Env</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Environment variable and their information.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span></code></div><div class="spec-doc"><p>The type for information about commands.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmd (cmdliner.Cmdliner.Cmd)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » Cmd</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner.Cmd</span></code></h1><p>Commands.</p><p>Command line syntaxes are implicitely defined by <a href="../Term/index.html"><code>Term</code></a>s. A command value binds a syntax and its documentation to a command name.</p><p>A command can group a list of sub commands (and recursively). In this case your tool defines a tree of commands, each with its own command line syntax. The root of that tree is called the <em>main command</em>; it represents your tool and its name.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#info">Command information</a></li><li><a href="#cmds">Commands</a></li><li><a href="#eval">Evaluation</a><ul><li><a href="#eval_low">Low level evaluation</a></li></ul></li></ul></nav></div><div class="odoc-content"><h2 id="info"><a href="#info" class="anchor"></a>Command information</h2><p>Command information defines the name and documentation of a command.</p><div class="odoc-spec"><div class="spec module anchored" id="module-Exit"><a href="#module-Exit" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exit/index.html">Exit</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Exit codes and their information.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Env"><a href="#module-Env" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Env/index.html">Env</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Environment variable and their information.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span></code></div><div class="spec-doc"><p>The type for information about commands.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info :
|
||||
<span><span class="optlabel">?deprecated</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?man_xrefs</span>:<span><a href="../Manpage/index.html#type-xref">Manpage.xref</a> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?man</span>:<span><a href="../Manpage/index.html#type-block">Manpage.block</a> list</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (cmdliner.Cmdliner.Term.Syntax)</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">cmdliner</a> » <a href="../../index.html">Cmdliner</a> » <a href="../index.html">Term</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Term.Syntax</span></code></h1><p><code>let</code> operators.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-let+"><a href="#val-let+" class="anchor"></a><code><span><span class="keyword">val</span> let+ : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>( let+ )</code> is <a href="../index.html#val-map"><code>map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-and+"><a href="#val-and+" class="anchor"></a><code><span><span class="keyword">val</span> and+ : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>( and* )</code> is <a href="../index.html#val-product"><code>product</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (cmdliner.Cmdliner.Term.Syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">Term</a> » Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Term.Syntax</span></code></h1><p><code>let</code> operators.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(let+)"><a href="#val-(let+)" class="anchor"></a><code><span><span class="keyword">val</span> (let+) : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>( let+ )</code> is <a href="../index.html#val-map"><code>map</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(and+)"><a href="#val-(and+)" class="anchor"></a><code><span><span class="keyword">val</span> (and+) : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span> * <span class="type-var">'b</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>( and* )</code> is <a href="../index.html#val-product"><code>product</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmdliner (cmdliner.Cmdliner)</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">cmdliner</a> » Cmdliner</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner</span></code></h1><p>Declarative definition of command line interfaces.</p><p>Consult the <a href="../tutorial.html" title="tutorial">tutorial</a>, details about the supported <a href="../cli.html" title="cli">command line syntax</a> and <a href="../examples.html" title="examples">examples</a> of use.</p><p>Open the module to use it, it defines only three modules in your scope.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Manpage"><a href="#module-Manpage" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Manpage/index.html">Manpage</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Man page specification.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Term"><a href="#module-Term" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Term/index.html">Term</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Terms.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cmd"><a href="#module-Cmd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cmd/index.html">Cmd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Commands.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Arg/index.html">Arg</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Terms for command line arguments.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cmdliner (cmdliner.Cmdliner)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » Cmdliner</nav><header class="odoc-preamble"><h1>Module <code><span>Cmdliner</span></code></h1><p>Declarative definition of command line interfaces.</p><p>Consult the <a href="../tutorial.html" title="tutorial">tutorial</a>, details about the supported <a href="../cli.html" title="cli">command line syntax</a> and <a href="../examples.html" title="examples">examples</a> of use.</p><p>Open the module to use it, it defines only three modules in your scope.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Manpage"><a href="#module-Manpage" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Manpage/index.html">Manpage</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Man page specification.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Term"><a href="#module-Term" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Term/index.html">Term</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Terms.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Cmd"><a href="#module-Cmd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Cmd/index.html">Cmd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Commands.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Arg/index.html">Arg</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Terms for command line arguments.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>examples (cmdliner.examples)</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">cmdliner</a> » examples</nav><header class="odoc-preamble"><h1 id="examples"><a href="#examples" class="anchor"></a>Examples</h1><p>The examples are self-contained, cut and paste them in a file to play with them.</p></header><nav class="odoc-toc"><ul><li><a href="#exrm">A <code>rm</code> command</a></li><li><a href="#excp">A <code>cp</code> command</a></li><li><a href="#extail">A <code>tail</code> command</a></li><li><a href="#exdarcs">A <code>darcs</code> command</a></li></ul></nav><div class="odoc-content"><h2 id="exrm"><a href="#exrm" class="anchor"></a>A <code>rm</code> command</h2><p>We define the command line interface of an <code>rm</code> command with the synopsis:</p><pre>rm [OPTION]… FILE…</pre><p>The <code>-f</code>, <code>-i</code> and <code>-I</code> flags define the prompt behaviour of <code>rm</code>. It is represented in our program by the <code>prompt</code> type. If more than one of these flags is present on the command line the last one takes precedence.</p><p>To implement this behaviour we map the presence of these flags to values of the <code>prompt</code> type by using <a href="Cmdliner/Arg/index.html#val-vflag_all"><code>Cmdliner.Arg.vflag_all</code></a>.</p><p>This argument will contain all occurrences of the flag on the command line and we just take the <a href="Cmdliner/Arg/index.html#val-last"><code>Cmdliner.Arg.last</code></a> one to define our term value. If there is no occurrence the last value of the default list <code>[Always]</code> is taken. This means the default prompt behaviour is <code>Always</code>.</p><pre class="language-ocaml"><code>(* Implementation of the command, we just print the args. *)
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>examples (cmdliner.examples)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » examples</nav><header class="odoc-preamble"><h1 id="examples"><a href="#examples" class="anchor"></a>Examples</h1><p>The examples are self-contained, cut and paste them in a file to play with them.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#exrm">A <code>rm</code> command</a></li><li><a href="#excp">A <code>cp</code> command</a></li><li><a href="#extail">A <code>tail</code> command</a></li><li><a href="#exdarcs">A <code>darcs</code> command</a></li></ul></nav></div><div class="odoc-content"><h2 id="exrm"><a href="#exrm" class="anchor"></a>A <code>rm</code> command</h2><p>We define the command line interface of an <code>rm</code> command with the synopsis:</p><pre>rm [OPTION]… FILE…</pre><p>The <code>-f</code>, <code>-i</code> and <code>-I</code> flags define the prompt behaviour of <code>rm</code>. It is represented in our program by the <code>prompt</code> type. If more than one of these flags is present on the command line the last one takes precedence.</p><p>To implement this behaviour we map the presence of these flags to values of the <code>prompt</code> type by using <a href="Cmdliner/Arg/index.html#val-vflag_all"><code>Cmdliner.Arg.vflag_all</code></a>.</p><p>This argument will contain all occurrences of the flag on the command line and we just take the <a href="Cmdliner/Arg/index.html#val-last"><code>Cmdliner.Arg.last</code></a> one to define our term value. If there is no occurrence the last value of the default list <code>[Always]</code> is taken. This means the default prompt behaviour is <code>Always</code>.</p><pre class="language-ocaml"><code>(* Implementation of the command, we just print the args. *)
|
||||
|
||||
type prompt = Always | Once | Never
|
||||
let prompt_str = function
|
||||
|
|
@ -188,8 +188,7 @@ let cmd =
|
|||
|
||||
|
||||
let main () = exit (Cmd.eval cmd)
|
||||
let () = main ()</code></pre><h2 id="exdarcs"><a href="#exdarcs" class="anchor"></a>A <code>darcs</code> command</h2><p>We define the command line interface of a <code>darcs</code> command with the synopsis:</p><pre>darcs [COMMAND] …</pre><p>The <code>--debug</code>, <code>-q</code>, <code>-v</code> and <code>--prehook</code> options are available in each command. To avoid having to pass them individually to each command we gather them in a record of type <code>copts</code>. By lifting the record constructor <code>copts</code> into the term <code>copts_t</code> we now have a term that we can pass to the commands to stand for an argument of type <code>copts</code>. These options are documented in a section called <code>COMMON
|
||||
OPTIONS</code>, since we also want to put <code>--help</code> and <code>--version</code> in this section, the term information of commands makes a judicious use of the <code>sdocs</code> parameter of <a href="Cmdliner/Term/index.html#val-info"><code>Cmdliner.Term.info</code></a>.</p><p>The <code>help</code> command shows help about commands or other topics. The help shown for commands is generated by <code>Cmdliner</code> by making an appropriate use of <a href="Cmdliner/Term/index.html#val-ret"><code>Cmdliner.Term.ret</code></a> on the lifted <code>help</code> function.</p><p>If the program is invoked without a command we just want to show the help of the program as printed by <code>Cmdliner</code> with <code>--help</code>. This is done by the <code>default_cmd</code> term.</p><pre class="language-ocaml"><code>(* Implementations, just print the args. *)
|
||||
let () = main ()</code></pre><h2 id="exdarcs"><a href="#exdarcs" class="anchor"></a>A <code>darcs</code> command</h2><p>We define the command line interface of a <code>darcs</code> command with the synopsis:</p><pre>darcs [COMMAND] …</pre><p>The <code>--debug</code>, <code>-q</code>, <code>-v</code> and <code>--prehook</code> options are available in each command. To avoid having to pass them individually to each command we gather them in a record of type <code>copts</code>. By lifting the record constructor <code>copts</code> into the term <code>copts_t</code> we now have a term that we can pass to the commands to stand for an argument of type <code>copts</code>. These options are documented in a section called <code>COMMON OPTIONS</code>, since we also want to put <code>--help</code> and <code>--version</code> in this section, the term information of commands makes a judicious use of the <code>sdocs</code> parameter of <a href="Cmdliner/Term/index.html#val-info"><code>Cmdliner.Term.info</code></a>.</p><p>The <code>help</code> command shows help about commands or other topics. The help shown for commands is generated by <code>Cmdliner</code> by making an appropriate use of <a href="Cmdliner/Term/index.html#val-ret"><code>Cmdliner.Term.ret</code></a> on the lifted <code>help</code> function.</p><p>If the program is invoked without a command we just want to show the help of the program as printed by <code>Cmdliner</code> with <code>--help</code>. This is done by the <code>default_cmd</code> term.</p><pre class="language-ocaml"><code>(* Implementations, just print the args. *)
|
||||
|
||||
type verb = Normal | Quiet | Verbose
|
||||
type copts = { debug : bool; verb : verb; prehook : string option }
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cmdliner.index)</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> – cmdliner</nav><header class="odoc-preamble"><h1 id="package-cmdliner"><a href="#package-cmdliner" class="anchor"></a>Package cmdliner <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p><code>Cmdliner</code> provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions.</p><p>The library automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands (like <code>git</code>) and respect most of the <a href="http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html">POSIX</a> and <a href="http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html">GNU</a> conventions.</p></header><nav class="odoc-toc"><ul><li><a href="#manuals">Manuals</a></li><li><a href="#api">API</a></li><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="manuals"><a href="#manuals" class="anchor"></a>Manuals</h2><p>The following manuals are available.</p><ul><li>The <a href="tutorial.html" title="tutorial">tutorial</a> gets you through the steps to write your first command line interface with Cmdliner.</li><li>The <a href="cli.html" title="cli">Command line interface manual</a> describes how command lines and environment variables are parsed by Cmdliner.</li><li><a href="tool_man.html" title="tool_man">Tool man pages</a> describes how Cmdliner generates man pages for your tools and how you can format them.</li><li>The <a href="examples.html" title="examples">examples page</a> has a few annoted examples that show to express the command line interface of a few classic tools with Cmdliner</li></ul><h2 id="api"><a href="#api" class="anchor"></a>API</h2><ul class="modules"><li><a href="Cmdliner/index.html"><code>Cmdliner</code></a> <span class="synopsis">Declarative definition of command line interfaces.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cmdliner.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » cmdliner</nav><header class="odoc-preamble"><h1 id="package-cmdliner"><a href="#package-cmdliner" class="anchor"></a>Package cmdliner <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p><code>Cmdliner</code> provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions.</p><p>The library automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands (like <code>git</code>) and respect most of the <a href="http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html">POSIX</a> and <a href="http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html">GNU</a> conventions.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#manuals">Manuals</a></li><li><a href="#api">API</a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="manuals"><a href="#manuals" class="anchor"></a>Manuals</h2><p>The following manuals are available.</p><ul><li>The <a href="tutorial.html" title="tutorial">tutorial</a> gets you through the steps to write your first command line interface with Cmdliner.</li><li>The <a href="cli.html" title="cli">Command line interface manual</a> describes how command lines and environment variables are parsed by Cmdliner.</li><li><a href="tool_man.html" title="tool_man">Tool man pages</a> describes how Cmdliner generates man pages for your tools and how you can format them.</li><li>The <a href="examples.html" title="examples">examples page</a> has a few annoted examples that show to express the command line interface of a few classic tools with Cmdliner</li></ul><h2 id="api"><a href="#api" class="anchor"></a>API</h2><ul class="modules"><li><a href="Cmdliner/index.html"><code>Cmdliner</code></a> <span class="synopsis">Declarative definition of command line interfaces.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>tutorial (cmdliner.tutorial)</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">cmdliner</a> » tutorial</nav><header class="odoc-preamble"><h1 id="tutorial"><a href="#tutorial" class="anchor"></a>Tutorial</h1></header><nav class="odoc-toc"><ul><li><a href="#started">Getting started</a></li><li><a href="#subcommands">Sub commands</a></li></ul></nav><div class="odoc-content"><h2 id="started"><a href="#started" class="anchor"></a>Getting started</h2><p>With <code>Cmdliner</code> your tool's <code>main</code> function evaluates a command.</p><p>A command is a value of type <a href="Cmdliner/Cmd/index.html#type-t"><code>Cmdliner.Cmd.t</code></a> which gathers a command name and a term of type <a href="Cmdliner/Term/index.html#type-t"><code>Cmdliner.Term.t</code></a>. A term is an expression to be evaluated. The type parameter of the term (and the command) indicates the type of the result of the evaluation.</p><p>One way to create terms is by lifting regular OCaml values with <a href="Cmdliner/Term/index.html#val-const"><code>Cmdliner.Term.const</code></a>. Terms can be applied to terms evaluating to functional values with <a href="Cmdliner/Term/index.html#val-($)"><code>Cmdliner.Term.($)</code></a>.</p><p>For example, in a <code>revolt.ml</code> file, for the function:</p><pre class="language-ocaml"><code>let revolt () = print_endline "Revolt!"</code></pre><p>the term :</p><pre class="language-ocaml"><code>open Cmdliner
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>tutorial (cmdliner.tutorial)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » tutorial</nav><header class="odoc-preamble"><h1 id="tutorial"><a href="#tutorial" class="anchor"></a>Tutorial</h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#started">Getting started</a></li><li><a href="#subcommands">Sub commands</a></li></ul></nav></div><div class="odoc-content"><h2 id="started"><a href="#started" class="anchor"></a>Getting started</h2><p>With <code>Cmdliner</code> your tool's <code>main</code> function evaluates a command.</p><p>A command is a value of type <a href="Cmdliner/Cmd/index.html#type-t"><code>Cmdliner.Cmd.t</code></a> which gathers a command name and a term of type <a href="Cmdliner/Term/index.html#type-t"><code>Cmdliner.Term.t</code></a>. A term is an expression to be evaluated. The type parameter of the term (and the command) indicates the type of the result of the evaluation.</p><p>One way to create terms is by lifting regular OCaml values with <a href="Cmdliner/Term/index.html#val-const"><code>Cmdliner.Term.const</code></a>. Terms can be applied to terms evaluating to functional values with <a href="Cmdliner/Term/index.html#val-($)"><code>Cmdliner.Term.($)</code></a>.</p><p>For example, in a <code>revolt.ml</code> file, for the function:</p><pre class="language-ocaml"><code>let revolt () = print_endline "Revolt!"</code></pre><p>the term :</p><pre class="language-ocaml"><code>open Cmdliner
|
||||
|
||||
let revolt_t = Term.(const revolt $ const ())</code></pre><p>is a term that evaluates to the result (and effect) of the <code>revolt</code> function. This term can be attached to a command:</p><pre class="language-ocaml"><code>let cmd = Cmd.v (Cmd.info "revolt") revolt_t</code></pre><p>and evaluated with <a href="Cmdliner/Cmd/index.html#val-eval"><code>Cmdliner.Cmd.eval</code></a>:</p><pre class="language-ocaml"><code>let () = exit (Cmd.eval cmd)</code></pre><p>This defines a command line tool named <code>"revolt"</code> (this name will be used in error reporting and documentation generation), without command line arguments, that just prints <code>"Revolt!"</code> on <code>stdout</code>.</p><pre class="language-ocaml"><code>> ocamlfind ocamlopt -linkpkg -package cmdliner -o revolt revolt.ml
|
||||
> ./revolt
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,6 +1,6 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fmt_cli (fmt.Fmt_cli)</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">fmt</a> » Fmt_cli</nav><header class="odoc-preamble"><h1>Module <code><span>Fmt_cli</span></code></h1><p><a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <code>Fmt</code>.</p></header><nav class="odoc-toc"><ul><li><a href="#option-for-setting-the-style-renderer">Option for setting the style renderer</a></li></ul></nav><div class="odoc-content"><h2 id="option-for-setting-the-style-renderer"><a href="#option-for-setting-the-style-renderer" class="anchor"></a>Option for setting the style renderer</h2><div class="odoc-spec"><div class="spec value anchored" id="val-style_renderer"><a href="#val-style_renderer" class="anchor"></a><code><span><span class="keyword">val</span> style_renderer :
|
||||
<span><span class="optlabel">?env</span>:<a href="../../cmdliner/Cmdliner/Arg/index.html#type-env">Cmdliner.Arg.env</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fmt_cli (fmt.Fmt_cli)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">fmt</a> » Fmt_cli</nav><header class="odoc-preamble"><h1>Module <code><span>Fmt_cli</span></code></h1><p><a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <code>Fmt</code>.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#option-for-setting-the-style-renderer">Option for setting the style renderer</a></li></ul></nav></div><div class="odoc-content"><h2 id="option-for-setting-the-style-renderer"><a href="#option-for-setting-the-style-renderer" class="anchor"></a>Option for setting the style renderer</h2><div class="odoc-spec"><div class="spec value anchored" id="val-style_renderer"><a href="#val-style_renderer" class="anchor"></a><code><span><span class="keyword">val</span> style_renderer :
|
||||
<span><span class="optlabel">?env</span>:<a href="../../cmdliner/Cmdliner/Cmd/Env/index.html#type-info">Cmdliner.Cmd.Env.info</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?docs</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span><span><a href="../Fmt/index.html#type-style_renderer">Fmt.style_renderer</a> option</span> <a href="../../cmdliner/Cmdliner/Term/index.html#type-t">Cmdliner.Term.t</a></span></span></code></div><div class="spec-doc"><p><code>style_renderer ?env ?docs ()</code> is a <a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> option <code>--color</code> that can be directly used with the optional arguments of <a href="../Fmt_tty/index.html#tty_setup" title="tty_setup">TTY setup</a> or to control <a href="../Fmt/index.html#val-set_style_renderer" title="Fmt.set_style_renderer">style rendering</a>. The option is documented under <code>docs</code> (defaults to the default in <a href="../../cmdliner/Cmdliner/Arg/index.html#type-info"><code>Cmdliner.Arg.info</code></a>).</p><p>The option is a tri-state enumerated value that when used with <a href="../Fmt_tty/index.html#tty_setup" title="tty_setup">TTY setup</a> takes over the automatic setup:</p><ul><li><code>--color=never</code>, the value is <code>Some `None</code>, forces no styling.</li><li><code>--color=always</code>, the value is <code>Some `Ansi</code>, forces ANSI styling.</li><li><code>--color=auto</code> or absent, the value is <code>None</code>, automatic setup takes place.</li></ul><p>If <code>env</code> is provided, the option default value (<code>None</code>) can be overridden by the corresponding environment variable.</p></div></div></div></body></html>
|
||||
<span><span><a href="../Fmt/index.html#type-style_renderer">Fmt.style_renderer</a> option</span> <a href="../../cmdliner/Cmdliner/Term/index.html#type-t">Cmdliner.Term.t</a></span></span></code></div><div class="spec-doc"><p><code>style_renderer ?env ?docs ()</code> is a <a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> option <code>--color</code> that can be directly used with the optional arguments of <a href="../Fmt_tty/index.html#tty_setup" title="tty_setup">TTY setup</a> or to control <a href="../Fmt/index.html#val-set_style_renderer" title="Fmt.set_style_renderer">style rendering</a>. The option is documented under <code>docs</code> (defaults to the default in <a href="../../cmdliner/Cmdliner/Arg/index.html#type-info"><code>Cmdliner.Arg.info</code></a>).</p><p>The option is a tri-state enumerated value that when used with <a href="../Fmt_tty/index.html#tty_setup" title="tty_setup">TTY setup</a> takes over the automatic setup:</p><ul><li><code>--color=never</code>, the value is <code>Some `None</code>, forces no styling.</li><li><code>--color=always</code>, the value is <code>Some `Ansi_tty</code>, forces ANSI styling.</li><li><code>--color=auto</code> or absent, the value is <code>None</code>, automatic setup takes place.</li></ul><p>If <code>env</code> is provided, the option default value (<code>None</code>) can be overridden by the corresponding environment variable.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fmt_tty (fmt.Fmt_tty)</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">fmt</a> » Fmt_tty</nav><header class="odoc-preamble"><h1>Module <code><span>Fmt_tty</span></code></h1><p><code>Fmt</code> TTY setup.</p><p><code>Fmt_tty</code> provides simple automatic setup on channel formatters for:</p><ul><li><a href="../Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a>. <code>`Ansi_tty</code> is used if the channel <span class="xref-unresolved" title="Unix.isatty">is a tty</span> and the environment variable <code>TERM</code> is defined and its value is not <code>"dumb"</code>. <code>`None</code> is used otherwise.</li><li><a href="../Fmt/index.html#val-set_utf_8"><code>Fmt.set_utf_8</code></a>. <code>true</code> is used if one of the following environment variables has <code>"UTF-8"</code> as a case insensitive substring: <code>LANG</code>, <code>LC_ALL</code>, <code>LC_CTYPE</code>.</li></ul></header><nav class="odoc-toc"><ul><li><a href="#tty_setup">TTY setup</a></li></ul></nav><div class="odoc-content"><h2 id="tty_setup"><a href="#tty_setup" class="anchor"></a>TTY setup</h2><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fmt_tty (fmt.Fmt_tty)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">fmt</a> » Fmt_tty</nav><header class="odoc-preamble"><h1>Module <code><span>Fmt_tty</span></code></h1><p><code>Fmt</code> TTY setup.</p><p><code>Fmt_tty</code> provides simple automatic setup on channel formatters for:</p><ul><li><a href="../Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a>. <code>`Ansi_tty</code> is used if the channel <span class="xref-unresolved" title="Unix.isatty">is a tty</span> and the environment variable <code>TERM</code> is defined and its value is not <code>"dumb"</code>. <code>`None</code> is used otherwise.</li><li><a href="../Fmt/index.html#val-set_utf_8"><code>Fmt.set_utf_8</code></a>. <code>true</code> is used if one of the following environment variables has <code>"UTF-8"</code> as a case insensitive substring: <code>LANG</code>, <code>LC_ALL</code>, <code>LC_CTYPE</code>.</li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#tty_setup">TTY setup</a></li></ul></nav></div><div class="odoc-content"><h2 id="tty_setup"><a href="#tty_setup" class="anchor"></a>TTY setup</h2><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup :
|
||||
<span><span class="optlabel">?style_renderer</span>:<a href="../Fmt/index.html#type-style_renderer">Fmt.style_renderer</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?utf_8</span>:bool <span class="arrow">-></span></span>
|
||||
<span><a href="../../ocaml/Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
v0.10.0 2025-03-10 La Forclaz (VS)
|
||||
----------------------------------
|
||||
|
||||
* Handle `cmdliner` deprecations.
|
||||
* Install each library in its own directory.
|
||||
* Add `Fmt.if'`, thanks to Rizo for the suggestion and patch.
|
||||
|
||||
v0.9.0 2021-10-22 Zagreb
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1,19 +1,18 @@
|
|||
Fmt — OCaml Format pretty-printer combinators
|
||||
-------------------------------------------------------------------------------
|
||||
v0.9.0
|
||||
=============================================
|
||||
|
||||
Fmt exposes combinators to devise `Format` pretty-printing functions.
|
||||
|
||||
Fmt depends only on the OCaml standard library. The optional `Fmt_tty`
|
||||
library that allows to setup formatters for terminal color output
|
||||
depends on the Unix library. The optional `Fmt_cli` library that
|
||||
provides command line support for Fmt depends on [`Cmdliner`][cmdliner].
|
||||
provides command line support for Fmt depends on [`cmdliner`].
|
||||
|
||||
Fmt is distributed under the ISC license.
|
||||
|
||||
[cmdliner]: http://erratique.ch/software/cmdliner
|
||||
Home page: <http://erratique.ch/software/fmt>
|
||||
|
||||
Home page: http://erratique.ch/software/fmt
|
||||
[`cmdliner`]: http://erratique.ch/software/cmdliner
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -27,9 +26,10 @@ instructions.
|
|||
|
||||
## Documentation
|
||||
|
||||
The documentation and API reference is automatically generated by
|
||||
`ocamldoc` from the interfaces. It can be consulted [online][doc]
|
||||
and there is a generated version in the `doc` directory of the
|
||||
distribution.
|
||||
The documentation can be consulted [online] or via `odig doc fmt`.
|
||||
|
||||
[doc]: http://erratique.ch/software/fmt/doc/
|
||||
Questions are welcome but better asked on the [OCaml forum] than on the
|
||||
issue tracker.
|
||||
|
||||
[online]: http://erratique.ch/software/fmt/doc/
|
||||
[OCaml forum]: https://discuss.ocaml.org/
|
||||
|
|
|
|||
15
fmt/_doc-dir/odoc-pages/index.mld
Normal file
15
fmt/_doc-dir/odoc-pages/index.mld
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
{0 Fmt {%html: <span class="version">v0.10.0</span>%}}
|
||||
|
||||
Fmt exposes combinators to devise {!Format} pretty-printing functions.
|
||||
|
||||
{1:library_fmt Library [fmt]}
|
||||
|
||||
{!modules: Fmt}
|
||||
|
||||
{1:library_tty Library [fmt.tty]}
|
||||
|
||||
{!modules: Fmt_tty}
|
||||
|
||||
{1:library_tty Library [fmt.cli]}
|
||||
|
||||
{!modules: Fmt_cli}
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (fmt.index)</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> – fmt</nav><header class="odoc-preamble"><h1 id="package-fmt"><a href="#package-fmt" class="anchor"></a>Package fmt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Fmt/index.html"><code>Fmt</code></a> <span class="synopsis"><code>Format</code> pretty-printer combinators.</span></li><li><a href="Fmt_cli/index.html"><code>Fmt_cli</code></a> <span class="synopsis"><a href="../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <code>Fmt</code>.</span></li><li><a href="Fmt_tty/index.html"><code>Fmt_tty</code></a> <span class="synopsis"><code>Fmt</code> TTY setup.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (fmt.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » fmt</nav><header class="odoc-preamble"><h1 id="package-fmt"><a href="#package-fmt" class="anchor"></a>Package fmt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p>Fmt exposes combinators to devise <code>Format</code> pretty-printing functions.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#library_fmt">Library <code>fmt</code></a></li><li><a href="#library_tty">Library <code>fmt.tty</code></a></li><li><a href="#library_tty_2">Library <code>fmt.cli</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="library_fmt"><a href="#library_fmt" class="anchor"></a>Library <code>fmt</code></h2><ul class="modules"><li><a href="Fmt/index.html"><code>Fmt</code></a> <span class="synopsis"><code>Format</code> pretty-printer combinators.</span></li></ul><h2 id="library_tty"><a href="#library_tty" class="anchor"></a>Library <code>fmt.tty</code></h2><ul class="modules"><li><a href="Fmt_tty/index.html"><code>Fmt_tty</code></a> <span class="synopsis"><code>Fmt</code> TTY setup.</span></li></ul><h2 id="library_tty_2"><a href="#library_tty_2" class="anchor"></a>Library <code>fmt.cli</code></h2><ul class="modules"><li><a href="Fmt_cli/index.html"><code>Fmt_cli</code></a> <span class="synopsis"><a href="../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <code>Fmt</code>.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Id (jsonrpc.Jsonrpc.Id)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Id</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Id</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.String" class="def variant constructor anchored"><a href="#type-t.String" class="anchor"></a><code><span>| </span><span>`String <span class="keyword">of</span> string</span></code></li><li id="type-t.Int" class="def variant constructor anchored"><a href="#type-t.Int" class="anchor"></a><code><span>| </span><span>`Int <span class="keyword">of</span> int</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Id (jsonrpc.Jsonrpc.Id)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Id</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Id</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.String" class="def variant constructor anchored"><a href="#type-t.String" class="anchor"></a><code><span>| </span><span>`String <span class="keyword">of</span> string</span></code></li><li id="type-t.Int" class="def variant constructor anchored"><a href="#type-t.Int" class="anchor"></a><code><span>| </span><span>`Int <span class="keyword">of</span> int</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonable (jsonrpc.Jsonrpc.Json.Jsonable)</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">jsonrpc</a> » <a href="../../index.html">Jsonrpc</a> » <a href="../index.html">Json</a> » Jsonable</nav><header class="odoc-preamble"><h1>Module <code><span>Json.Jsonable</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonable (jsonrpc.Jsonrpc.Json.Jsonable)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../../index.html">Jsonrpc</a> » <a href="../index.html">Json</a> » Jsonable</nav><header class="odoc-preamble"><h1>Module <code><span>Json.Jsonable</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (jsonrpc.Jsonrpc.Json.Jsonable.S)</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">jsonrpc</a> » <a href="../../../index.html">Jsonrpc</a> » <a href="../../index.html">Json</a> » <a href="../index.html">Jsonable</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Jsonable.S</span></code></h1></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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (jsonrpc.Jsonrpc.Json.Jsonable.S)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../../../index.html">Jsonrpc</a> » <a href="../../index.html">Json</a> » <a href="../index.html">Jsonable</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Jsonable.S</span></code></h1></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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../index.html#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Json (jsonrpc.Jsonrpc.Json)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Json</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Json</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.Assoc" class="def variant constructor anchored"><a href="#type-t.Assoc" class="anchor"></a><code><span>| </span><span>`Assoc <span class="keyword">of</span> <span><span>(string * <a href="#type-t">t</a>)</span> list</span></span></code></li><li id="type-t.Bool" class="def variant constructor anchored"><a href="#type-t.Bool" class="anchor"></a><code><span>| </span><span>`Bool <span class="keyword">of</span> bool</span></code></li><li id="type-t.Float" class="def variant constructor anchored"><a href="#type-t.Float" class="anchor"></a><code><span>| </span><span>`Float <span class="keyword">of</span> float</span></code></li><li id="type-t.Int" class="def variant constructor anchored"><a href="#type-t.Int" class="anchor"></a><code><span>| </span><span>`Int <span class="keyword">of</span> int</span></code></li><li id="type-t.Intlit" class="def variant constructor anchored"><a href="#type-t.Intlit" class="anchor"></a><code><span>| </span><span>`Intlit <span class="keyword">of</span> string</span></code></li><li id="type-t.List" class="def variant constructor anchored"><a href="#type-t.List" class="anchor"></a><code><span>| </span><span>`List <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></li><li id="type-t.Null" class="def variant constructor anchored"><a href="#type-t.Null" class="anchor"></a><code><span>| </span><span>`Null</span></code></li><li id="type-t.String" class="def variant constructor anchored"><a href="#type-t.String" class="anchor"></a><code><span>| </span><span>`String <span class="keyword">of</span> string</span></code></li><li id="type-t.Tuple" class="def variant constructor anchored"><a href="#type-t.Tuple" class="anchor"></a><code><span>| </span><span>`Tuple <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></li><li id="type-t.Variant" class="def variant constructor anchored"><a href="#type-t.Variant" class="anchor"></a><code><span>| </span><span>`Variant <span class="keyword">of</span> string * <span><a href="#type-t">t</a> option</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Of_json"><a href="#exception-Of_json" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Of_json</span> <span class="keyword">of</span> string * <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Raised when conversions from json fail</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Jsonable"><a href="#module-Jsonable" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Jsonable/index.html">Jsonable</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Json (jsonrpc.Jsonrpc.Json)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Json</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Json</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.Assoc" class="def variant constructor anchored"><a href="#type-t.Assoc" class="anchor"></a><code><span>| </span><span>`Assoc <span class="keyword">of</span> <span><span>(string * <a href="#type-t">t</a>)</span> list</span></span></code></li><li id="type-t.Bool" class="def variant constructor anchored"><a href="#type-t.Bool" class="anchor"></a><code><span>| </span><span>`Bool <span class="keyword">of</span> bool</span></code></li><li id="type-t.Float" class="def variant constructor anchored"><a href="#type-t.Float" class="anchor"></a><code><span>| </span><span>`Float <span class="keyword">of</span> float</span></code></li><li id="type-t.Int" class="def variant constructor anchored"><a href="#type-t.Int" class="anchor"></a><code><span>| </span><span>`Int <span class="keyword">of</span> int</span></code></li><li id="type-t.Intlit" class="def variant constructor anchored"><a href="#type-t.Intlit" class="anchor"></a><code><span>| </span><span>`Intlit <span class="keyword">of</span> string</span></code></li><li id="type-t.List" class="def variant constructor anchored"><a href="#type-t.List" class="anchor"></a><code><span>| </span><span>`List <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></li><li id="type-t.Null" class="def variant constructor anchored"><a href="#type-t.Null" class="anchor"></a><code><span>| </span><span>`Null</span></code></li><li id="type-t.String" class="def variant constructor anchored"><a href="#type-t.String" class="anchor"></a><code><span>| </span><span>`String <span class="keyword">of</span> string</span></code></li><li id="type-t.Tuple" class="def variant constructor anchored"><a href="#type-t.Tuple" class="anchor"></a><code><span>| </span><span>`Tuple <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></li><li id="type-t.Variant" class="def variant constructor anchored"><a href="#type-t.Variant" class="anchor"></a><code><span>| </span><span>`Variant <span class="keyword">of</span> string * <span><a href="#type-t">t</a> option</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Of_json"><a href="#exception-Of_json" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Of_json</span> <span class="keyword">of</span> string * <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Raised when conversions from json fail</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Jsonable"><a href="#module-Jsonable" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Jsonable/index.html">Jsonable</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Notification (jsonrpc.Jsonrpc.Notification)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Notification</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Notification</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.method_" class="def record field anchored"><a href="#type-t.method_" class="anchor"></a><code><span>method_ : string;</span></code></li><li id="type-t.params" class="def record field anchored"><a href="#type-t.params" class="anchor"></a><code><span>params : <span><a href="../Structured/index.html#type-t">Structured.t</a> option</span>;</span></code></li></ol><code><span>}</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><span class="optlabel">?params</span>:<a href="../Structured/index.html#type-t">Structured.t</a> <span class="arrow">-></span></span> <span><span class="label">method_</span>:string <span class="arrow">-></span></span> <span>unit <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Notification (jsonrpc.Jsonrpc.Notification)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Notification</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Notification</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.method_" class="def record field anchored"><a href="#type-t.method_" class="anchor"></a><code><span>method_ : string;</span></code></li><li id="type-t.params" class="def record field anchored"><a href="#type-t.params" class="anchor"></a><code><span>params : <span><a href="../Structured/index.html#type-t">Structured.t</a> option</span>;</span></code></li></ol><code><span>}</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><span class="optlabel">?params</span>:<a href="../Structured/index.html#type-t">Structured.t</a> <span class="arrow">-></span></span> <span><span class="label">method_</span>:string <span class="arrow">-></span></span> <span>unit <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Packet (jsonrpc.Jsonrpc.Packet)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Packet</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Packet</span></code></h1></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><span> = </span></code><ol><li id="type-t.Notification" class="def variant constructor anchored"><a href="#type-t.Notification" class="anchor"></a><code><span>| </span><span><span class="constructor">Notification</span> <span class="keyword">of</span> <a href="../Notification/index.html#type-t">Notification.t</a></span></code></li><li id="type-t.Request" class="def variant constructor anchored"><a href="#type-t.Request" class="anchor"></a><code><span>| </span><span><span class="constructor">Request</span> <span class="keyword">of</span> <a href="../Request/index.html#type-t">Request.t</a></span></code></li><li id="type-t.Response" class="def variant constructor anchored"><a href="#type-t.Response" class="anchor"></a><code><span>| </span><span><span class="constructor">Response</span> <span class="keyword">of</span> <a href="../Response/index.html#type-t">Response.t</a></span></code></li><li id="type-t.Batch_response" class="def variant constructor anchored"><a href="#type-t.Batch_response" class="anchor"></a><code><span>| </span><span><span class="constructor">Batch_response</span> <span class="keyword">of</span> <span><a href="../Response/index.html#type-t">Response.t</a> list</span></span></code></li><li id="type-t.Batch_call" class="def variant constructor anchored"><a href="#type-t.Batch_call" class="anchor"></a><code><span>| </span><span><span class="constructor">Batch_call</span> <span class="keyword">of</span> <span><span>[ <span>`Request of <a href="../Request/index.html#type-t">Request.t</a></span> <span><span>| `Notification</span> of <a href="../Notification/index.html#type-t">Notification.t</a></span> ]</span> list</span></span></code></li></ol></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Packet (jsonrpc.Jsonrpc.Packet)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Packet</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Packet</span></code></h1></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><span> = </span></code><ol><li id="type-t.Notification" class="def variant constructor anchored"><a href="#type-t.Notification" class="anchor"></a><code><span>| </span><span><span class="constructor">Notification</span> <span class="keyword">of</span> <a href="../Notification/index.html#type-t">Notification.t</a></span></code></li><li id="type-t.Request" class="def variant constructor anchored"><a href="#type-t.Request" class="anchor"></a><code><span>| </span><span><span class="constructor">Request</span> <span class="keyword">of</span> <a href="../Request/index.html#type-t">Request.t</a></span></code></li><li id="type-t.Response" class="def variant constructor anchored"><a href="#type-t.Response" class="anchor"></a><code><span>| </span><span><span class="constructor">Response</span> <span class="keyword">of</span> <a href="../Response/index.html#type-t">Response.t</a></span></code></li><li id="type-t.Batch_response" class="def variant constructor anchored"><a href="#type-t.Batch_response" class="anchor"></a><code><span>| </span><span><span class="constructor">Batch_response</span> <span class="keyword">of</span> <span><a href="../Response/index.html#type-t">Response.t</a> list</span></span></code></li><li id="type-t.Batch_call" class="def variant constructor anchored"><a href="#type-t.Batch_call" class="anchor"></a><code><span>| </span><span><span class="constructor">Batch_call</span> <span class="keyword">of</span> <span><span>[ <span>`Request of <a href="../Request/index.html#type-t">Request.t</a></span> <span><span>| `Notification</span> of <a href="../Notification/index.html#type-t">Notification.t</a></span> ]</span> list</span></span></code></li></ol></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Request (jsonrpc.Jsonrpc.Request)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Request</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Request</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../Id/index.html#type-t">Id.t</a>;</span></code></li><li id="type-t.method_" class="def record field anchored"><a href="#type-t.method_" class="anchor"></a><code><span>method_ : string;</span></code></li><li id="type-t.params" class="def record field anchored"><a href="#type-t.params" class="anchor"></a><code><span>params : <span><a href="../Structured/index.html#type-t">Structured.t</a> option</span>;</span></code></li></ol><code><span>}</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><span class="optlabel">?params</span>:<a href="../Structured/index.html#type-t">Structured.t</a> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><span class="label">method_</span>:string <span class="arrow">-></span></span> <span>unit <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Request (jsonrpc.Jsonrpc.Request)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Request</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Request</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../Id/index.html#type-t">Id.t</a>;</span></code></li><li id="type-t.method_" class="def record field anchored"><a href="#type-t.method_" class="anchor"></a><code><span>method_ : string;</span></code></li><li id="type-t.params" class="def record field anchored"><a href="#type-t.params" class="anchor"></a><code><span>params : <span><a href="../Structured/index.html#type-t">Structured.t</a> option</span>;</span></code></li></ol><code><span>}</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><span class="optlabel">?params</span>:<a href="../Structured/index.html#type-t">Structured.t</a> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><span class="label">method_</span>:string <span class="arrow">-></span></span> <span>unit <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Code (jsonrpc.Jsonrpc.Response.Error.Code)</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">jsonrpc</a> » <a href="../../../index.html">Jsonrpc</a> » <a href="../../index.html">Response</a> » <a href="../index.html">Error</a> » Code</nav><header class="odoc-preamble"><h1>Module <code><span>Error.Code</span></code></h1></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><span> = </span></code><ol><li id="type-t.ParseError" class="def variant constructor anchored"><a href="#type-t.ParseError" class="anchor"></a><code><span>| </span><span><span class="constructor">ParseError</span></span></code></li><li id="type-t.InvalidRequest" class="def variant constructor anchored"><a href="#type-t.InvalidRequest" class="anchor"></a><code><span>| </span><span><span class="constructor">InvalidRequest</span></span></code></li><li id="type-t.MethodNotFound" class="def variant constructor anchored"><a href="#type-t.MethodNotFound" class="anchor"></a><code><span>| </span><span><span class="constructor">MethodNotFound</span></span></code></li><li id="type-t.InvalidParams" class="def variant constructor anchored"><a href="#type-t.InvalidParams" class="anchor"></a><code><span>| </span><span><span class="constructor">InvalidParams</span></span></code></li><li id="type-t.InternalError" class="def variant constructor anchored"><a href="#type-t.InternalError" class="anchor"></a><code><span>| </span><span><span class="constructor">InternalError</span></span></code></li><li id="type-t.ServerErrorStart" class="def variant constructor anchored"><a href="#type-t.ServerErrorStart" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerErrorStart</span></span></code></li><li id="type-t.ServerErrorEnd" class="def variant constructor anchored"><a href="#type-t.ServerErrorEnd" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerErrorEnd</span></span></code></li><li id="type-t.ServerNotInitialized" class="def variant constructor anchored"><a href="#type-t.ServerNotInitialized" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerNotInitialized</span></span></code></li><li id="type-t.UnknownErrorCode" class="def variant constructor anchored"><a href="#type-t.UnknownErrorCode" class="anchor"></a><code><span>| </span><span><span class="constructor">UnknownErrorCode</span></span></code></li><li id="type-t.RequestFailed" class="def variant constructor anchored"><a href="#type-t.RequestFailed" class="anchor"></a><code><span>| </span><span><span class="constructor">RequestFailed</span></span></code></li><li id="type-t.ServerCancelled" class="def variant constructor anchored"><a href="#type-t.ServerCancelled" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerCancelled</span></span></code></li><li id="type-t.ContentModified" class="def variant constructor anchored"><a href="#type-t.ContentModified" class="anchor"></a><code><span>| </span><span><span class="constructor">ContentModified</span></span></code></li><li id="type-t.RequestCancelled" class="def variant constructor anchored"><a href="#type-t.RequestCancelled" class="anchor"></a><code><span>| </span><span><span class="constructor">RequestCancelled</span></span></code></li><li id="type-t.Other" class="def variant constructor anchored"><a href="#type-t.Other" class="anchor"></a><code><span>| </span><span><span class="constructor">Other</span> <span class="keyword">of</span> int</span></code></li></ol></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Code (jsonrpc.Jsonrpc.Response.Error.Code)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../../../index.html">Jsonrpc</a> » <a href="../../index.html">Response</a> » <a href="../index.html">Error</a> » Code</nav><header class="odoc-preamble"><h1>Module <code><span>Error.Code</span></code></h1></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><span> = </span></code><ol><li id="type-t.ParseError" class="def variant constructor anchored"><a href="#type-t.ParseError" class="anchor"></a><code><span>| </span><span><span class="constructor">ParseError</span></span></code></li><li id="type-t.InvalidRequest" class="def variant constructor anchored"><a href="#type-t.InvalidRequest" class="anchor"></a><code><span>| </span><span><span class="constructor">InvalidRequest</span></span></code></li><li id="type-t.MethodNotFound" class="def variant constructor anchored"><a href="#type-t.MethodNotFound" class="anchor"></a><code><span>| </span><span><span class="constructor">MethodNotFound</span></span></code></li><li id="type-t.InvalidParams" class="def variant constructor anchored"><a href="#type-t.InvalidParams" class="anchor"></a><code><span>| </span><span><span class="constructor">InvalidParams</span></span></code></li><li id="type-t.InternalError" class="def variant constructor anchored"><a href="#type-t.InternalError" class="anchor"></a><code><span>| </span><span><span class="constructor">InternalError</span></span></code></li><li id="type-t.ServerErrorStart" class="def variant constructor anchored"><a href="#type-t.ServerErrorStart" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerErrorStart</span></span></code></li><li id="type-t.ServerErrorEnd" class="def variant constructor anchored"><a href="#type-t.ServerErrorEnd" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerErrorEnd</span></span></code></li><li id="type-t.ServerNotInitialized" class="def variant constructor anchored"><a href="#type-t.ServerNotInitialized" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerNotInitialized</span></span></code></li><li id="type-t.UnknownErrorCode" class="def variant constructor anchored"><a href="#type-t.UnknownErrorCode" class="anchor"></a><code><span>| </span><span><span class="constructor">UnknownErrorCode</span></span></code></li><li id="type-t.RequestFailed" class="def variant constructor anchored"><a href="#type-t.RequestFailed" class="anchor"></a><code><span>| </span><span><span class="constructor">RequestFailed</span></span></code></li><li id="type-t.ServerCancelled" class="def variant constructor anchored"><a href="#type-t.ServerCancelled" class="anchor"></a><code><span>| </span><span><span class="constructor">ServerCancelled</span></span></code></li><li id="type-t.ContentModified" class="def variant constructor anchored"><a href="#type-t.ContentModified" class="anchor"></a><code><span>| </span><span><span class="constructor">ContentModified</span></span></code></li><li id="type-t.RequestCancelled" class="def variant constructor anchored"><a href="#type-t.RequestCancelled" class="anchor"></a><code><span>| </span><span><span class="constructor">RequestCancelled</span></span></code></li><li id="type-t.Other" class="def variant constructor anchored"><a href="#type-t.Other" class="anchor"></a><code><span>| </span><span><span class="constructor">Other</span> <span class="keyword">of</span> int</span></code></li></ol></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Error (jsonrpc.Jsonrpc.Response.Error)</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">jsonrpc</a> » <a href="../../index.html">Jsonrpc</a> » <a href="../index.html">Response</a> » Error</nav><header class="odoc-preamble"><h1>Module <code><span>Response.Error</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Code"><a href="#module-Code" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Code/index.html">Code</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.code" class="def record field anchored"><a href="#type-t.code" class="anchor"></a><code><span>code : <a href="Code/index.html#type-t">Code.t</a>;</span></code></li><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : string;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><a href="../../Json/index.html#type-t">Json.t</a> option</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-E"><a href="#exception-E" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">E</span> <span class="keyword">of</span> <a href="#type-t">t</a></span></code></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">?data</span>:<a href="../../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <span><span class="label">code</span>:<a href="Code/index.html#type-t">Code.t</a> <span class="arrow">-></span></span> <span><span class="label">message</span>:string <span class="arrow">-></span></span> <span>unit <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-raise"><a href="#val-raise" class="anchor"></a><code><span><span class="keyword">val</span> raise : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_exn"><a href="#val-of_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_exn : <span>exn <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Error (jsonrpc.Jsonrpc.Response.Error)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../../index.html">Jsonrpc</a> » <a href="../index.html">Response</a> » Error</nav><header class="odoc-preamble"><h1>Module <code><span>Response.Error</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Code"><a href="#module-Code" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Code/index.html">Code</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.code" class="def record field anchored"><a href="#type-t.code" class="anchor"></a><code><span>code : <a href="Code/index.html#type-t">Code.t</a>;</span></code></li><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : string;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span>data : <span><a href="../../Json/index.html#type-t">Json.t</a> option</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-E"><a href="#exception-E" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">E</span> <span class="keyword">of</span> <a href="#type-t">t</a></span></code></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">?data</span>:<a href="../../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <span><span class="label">code</span>:<a href="Code/index.html#type-t">Code.t</a> <span class="arrow">-></span></span> <span><span class="label">message</span>:string <span class="arrow">-></span></span> <span>unit <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-raise"><a href="#val-raise" class="anchor"></a><code><span><span class="keyword">val</span> raise : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_exn"><a href="#val-of_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_exn : <span>exn <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../Json/index.html#type-t">Json.t</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Response (jsonrpc.Jsonrpc.Response)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Response</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Response</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Error"><a href="#module-Error" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Error/index.html">Error</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../Id/index.html#type-t">Id.t</a>;</span></code></li><li id="type-t.result" class="def record field anchored"><a href="#type-t.result" class="anchor"></a><code><span>result : <span><span>(<a href="../Json/index.html#type-t">Json.t</a>, <a href="Error/index.html#type-t">Error.t</a>)</span> <a href="../../../ocaml/Stdlib/Result/index.html#type-t">Stdlib.Result.t</a></span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ok"><a href="#val-ok" class="anchor"></a><code><span><span class="keyword">val</span> ok : <span><a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><a href="../Json/index.html#type-t">Json.t</a> <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-error"><a href="#val-error" class="anchor"></a><code><span><span class="keyword">val</span> error : <span><a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><a href="Error/index.html#type-t">Error.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Response (jsonrpc.Jsonrpc.Response)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Response</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Response</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Error"><a href="#module-Error" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Error/index.html">Error</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : <a href="../Id/index.html#type-t">Id.t</a>;</span></code></li><li id="type-t.result" class="def record field anchored"><a href="#type-t.result" class="anchor"></a><code><span>result : <span><span>(<a href="../Json/index.html#type-t">Json.t</a>, <a href="Error/index.html#type-t">Error.t</a>)</span> <a href="../../../ocaml/Stdlib/Result/index.html#type-t">Stdlib.Result.t</a></span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ok"><a href="#val-ok" class="anchor"></a><code><span><span class="keyword">val</span> ok : <span><a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><a href="../Json/index.html#type-t">Json.t</a> <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-error"><a href="#val-error" class="anchor"></a><code><span><span class="keyword">val</span> error : <span><a href="../Id/index.html#type-t">Id.t</a> <span class="arrow">-></span></span> <span><a href="Error/index.html#type-t">Error.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Structured (jsonrpc.Jsonrpc.Structured)</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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Structured</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Structured</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.Assoc" class="def variant constructor anchored"><a href="#type-t.Assoc" class="anchor"></a><code><span>| </span><span>`Assoc <span class="keyword">of</span> <span><span>(string * <a href="../Json/index.html#type-t">Json.t</a>)</span> list</span></span></code></li><li id="type-t.List" class="def variant constructor anchored"><a href="#type-t.List" class="anchor"></a><code><span>| </span><span>`List <span class="keyword">of</span> <span><a href="../Json/index.html#type-t">Json.t</a> list</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Structured (jsonrpc.Jsonrpc.Structured)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » <a href="../index.html">Jsonrpc</a> » Structured</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc.Structured</span></code></h1></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><span> = </span><span>[ </span></code><ol><li id="type-t.Assoc" class="def variant constructor anchored"><a href="#type-t.Assoc" class="anchor"></a><code><span>| </span><span>`Assoc <span class="keyword">of</span> <span><span>(string * <a href="../Json/index.html#type-t">Json.t</a>)</span> list</span></span></code></li><li id="type-t.List" class="def variant constructor anchored"><a href="#type-t.List" class="anchor"></a><code><span>| </span><span>`List <span class="keyword">of</span> <span><a href="../Json/index.html#type-t">Json.t</a> list</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Json/Jsonable/module-type-S/index.html">Json.Jsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Json/Jsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Json/index.html#type-t">Json.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../Json/index.html#type-t">Json.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></details></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc (jsonrpc.Jsonrpc)</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">jsonrpc</a> » Jsonrpc</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc</span></code></h1><p>Jsonrpc implementation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Json"><a href="#module-Json" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Json/index.html">Json</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-Id"><a href="#module-Id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Id/index.html">Id</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-Structured"><a href="#module-Structured" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Structured/index.html">Structured</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-Notification"><a href="#module-Notification" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Notification/index.html">Notification</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-Request"><a href="#module-Request" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Request/index.html">Request</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-Response"><a href="#module-Response" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Response/index.html">Response</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-Packet"><a href="#module-Packet" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Packet/index.html">Packet</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc (jsonrpc.Jsonrpc)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » Jsonrpc</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc</span></code></h1><p>Jsonrpc implementation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Json"><a href="#module-Json" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Json/index.html">Json</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-Id"><a href="#module-Id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Id/index.html">Id</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-Structured"><a href="#module-Structured" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Structured/index.html">Structured</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-Notification"><a href="#module-Notification" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Notification/index.html">Notification</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-Request"><a href="#module-Request" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Request/index.html">Request</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-Response"><a href="#module-Response" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Response/index.html">Response</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-Packet"><a href="#module-Packet" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Packet/index.html">Packet</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc__ (jsonrpc.Jsonrpc__)</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">jsonrpc</a> » Jsonrpc__</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc__ (jsonrpc.Jsonrpc__)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » Jsonrpc__</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc__Import (jsonrpc.Jsonrpc__Import)</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">jsonrpc</a> » Jsonrpc__Import</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc__Import</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc__Import (jsonrpc.Jsonrpc__Import)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">jsonrpc</a> » Jsonrpc__Import</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc__Import</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (jsonrpc.index)</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> – jsonrpc</nav><header class="odoc-preamble"><h1 id="package-jsonrpc"><a href="#package-jsonrpc" class="anchor"></a>Package jsonrpc <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Jsonrpc/index.html"><code>Jsonrpc</code></a> <span class="synopsis">Jsonrpc implementation</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (jsonrpc.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » jsonrpc</nav><header class="odoc-preamble"><h1 id="package-jsonrpc"><a href="#package-jsonrpc" class="anchor"></a>Package jsonrpc <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Jsonrpc/index.html"><code>Jsonrpc</code></a> <span class="synopsis">Jsonrpc implementation</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol-lwt.Linol_lwt.Jsonrpc2.Req_id)</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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc2.Req_id</span></code></h1></header><div class="odoc-content"><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</p><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="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol-lwt.Linol_lwt.Jsonrpc2.Req_id)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc2.Req_id</span></code></h1><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</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><span> = <a href="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol-lwt.Linol_lwt.Jsonrpc2.base_server)</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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol-lwt.Linol_lwt.Jsonrpc2.base_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request"><a href="#method-on_request" class="anchor"></a><code><span><span class="keyword">method</span> on_request : 'a. <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol-lwt.Linol_lwt.Jsonrpc2.notify_back)</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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol-lwt.Linol_lwt.Jsonrpc2.notify_back)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_uri"><a href="#method-set_uri" class="anchor"></a><code><span><span class="keyword">method</span> set_uri : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-telemetry"><a href="#method-telemetry" class="anchor"></a><code><span><span class="keyword">method</span> telemetry : <span><span class="xref-unresolved">Lsp__.Import.Json.t</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_begin"><a href="#method-work_done_progress_begin" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_begin : <span><a href="../../../../lsp/Lsp__/Types/WorkDoneProgressBegin/index.html#type-t">Lsp.Types.WorkDoneProgressBegin.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_end"><a href="#method-work_done_progress_end" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_end : <span><a href="../../../../lsp/Lsp__/Types/WorkDoneProgressEnd/index.html#type-t">Lsp.Types.WorkDoneProgressEnd.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_report"><a href="#method-work_done_progress_report" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_report : <span><a href="../../../../lsp/Lsp__/Types/WorkDoneProgressReport/index.html#type-t">Lsp.Types.WorkDoneProgressReport.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol-lwt.Linol_lwt.Jsonrpc2.server)</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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol-lwt.Linol_lwt.Jsonrpc2.server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol-lwt</a> » <a href="../../index.html">Linol_lwt</a> » <a href="../index.html">Jsonrpc2</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Jsonrpc2.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `CodeActionOptions</span> of
|
||||
<a href="../../../../lsp/Lsp__/Types/CodeActionOptions/index.html#type-t">Lsp.Types.CodeActionOptions.t</a></span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_lens_options"><a href="#method-config_code_lens_options" class="anchor"></a><code><span><span class="keyword">method</span> config_code_lens_options : <span><a href="../../../../lsp/Lsp__/Types/CodeLensOptions/index.html#type-t">Lsp.Types.CodeLensOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_completion"><a href="#method-config_completion" class="anchor"></a><code><span><span class="keyword">method</span> config_completion : <span><a href="../../../../lsp/Lsp__/Types/CompletionOptions/index.html#type-t">Lsp.Types.CompletionOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_definition"><a href="#method-config_definition" class="anchor"></a><code><span><span class="keyword">method</span> config_definition : <span><span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `DefinitionOptions</span> of
|
||||
|
|
@ -14,36 +14,36 @@
|
|||
<a href="../../../../lsp/Lsp__/Types/ServerCapabilities/index.html#type-t">Lsp.Types.ServerCapabilities.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_symbol"><a href="#method-config_symbol" class="anchor"></a><code><span><span class="keyword">method</span> config_symbol : <span><span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `DocumentSymbolOptions</span> of
|
||||
<a href="../../../../lsp/Lsp__/Types/DocumentSymbolOptions/index.html#type-t">Lsp.Types.DocumentSymbolOptions.t</a></span> ]</span>
|
||||
option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_sync_opts"><a href="#method-config_sync_opts" class="anchor"></a><code><span><span class="keyword">method</span> config_sync_opts : <a href="../../../../lsp/Lsp__/Types/TextDocumentSyncOptions/index.html#type-t">Lsp.Types.TextDocumentSyncOptions.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_change"><a href="#method-on_notif_doc_did_change" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_change : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_sync_opts"><a href="#method-config_sync_opts" class="anchor"></a><code><span><span class="keyword">method</span> config_sync_opts : <a href="../../../../lsp/Lsp__/Types/TextDocumentSyncOptions/index.html#type-t">Lsp.Types.TextDocumentSyncOptions.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_change"><a href="#method-on_notif_doc_did_change" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_change : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/VersionedTextDocumentIdentifier/index.html#type-t">Lsp.Types.VersionedTextDocumentIdentifier.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/TextDocumentContentChangeEvent/index.html#type-t">Lsp.Types.TextDocumentContentChangeEvent.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">old_content</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="label">new_content</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_close"><a href="#method-on_notif_doc_did_close" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_close : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_close"><a href="#method-on_notif_doc_did_close" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_close : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/TextDocumentIdentifier/index.html#type-t">Lsp.Types.TextDocumentIdentifier.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_open"><a href="#method-on_notif_doc_did_open" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_open : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_open"><a href="#method-on_notif_doc_did_open" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_open : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/TextDocumentItem/index.html#type-t">Lsp.Types.TextDocumentItem.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">content</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_save"><a href="#method-on_notif_doc_did_save" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_save : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_save"><a href="#method-on_notif_doc_did_save" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_save : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/DidSaveTextDocumentParams/index.html#type-t">Lsp.Types.DidSaveTextDocumentParams.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification_unhandled"><a href="#method-on_notification_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_notification_unhandled : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification_unhandled"><a href="#method-on_notification_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_notification_unhandled : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_action"><a href="#method-on_req_code_action" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_action : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_action"><a href="#method-on_req_code_action" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_action : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeActionParams/index.html#type-t">Lsp.Types.CodeActionParams.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeActionResult/index.html#type-t">Lsp.Types.CodeActionResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens"><a href="#method-on_req_code_lens" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeActionResult/index.html#type-t">Lsp.Types.CodeActionResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens"><a href="#method-on_req_code_lens" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">partialResultToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> list</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens_resolve"><a href="#method-on_req_code_lens_resolve" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens_resolve : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> list</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens_resolve"><a href="#method-on_req_code_lens_resolve" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens_resolve : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_completion"><a href="#method-on_req_completion" class="anchor"></a><code><span><span class="keyword">method</span> on_req_completion : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_completion"><a href="#method-on_req_completion" class="anchor"></a><code><span><span class="keyword">method</span> on_req_completion : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
|
|
@ -54,32 +54,32 @@
|
|||
<span><span><span>[ <span>`CompletionList of <span class="xref-unresolved">Lsp__.Types.CompletionList.t</span></span>
|
||||
<span><span>| `List</span> of <span><span class="xref-unresolved">Lsp__.Types.CompletionItem.t</span> list</span></span> ]</span>
|
||||
option</span>
|
||||
<a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_definition"><a href="#method-on_req_definition" class="anchor"></a><code><span><span class="keyword">method</span> on_req_definition : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_definition"><a href="#method-on_req_definition" class="anchor"></a><code><span><span class="keyword">method</span> on_req_definition : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">partialResultToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/Locations/index.html#type-t">Lsp.Types.Locations.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_execute_command"><a href="#method-on_req_execute_command" class="anchor"></a><code><span><span class="keyword">method</span> on_req_execute_command : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/Locations/index.html#type-t">Lsp.Types.Locations.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_execute_command"><a href="#method-on_req_execute_command" class="anchor"></a><code><span><span class="keyword">method</span> on_req_execute_command : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> list</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_hover"><a href="#method-on_req_hover" class="anchor"></a><code><span><span class="keyword">method</span> on_req_hover : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_hover"><a href="#method-on_req_hover" class="anchor"></a><code><span><span class="keyword">method</span> on_req_hover : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/Hover/index.html#type-t">Lsp.Types.Hover.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_initialize"><a href="#method-on_req_initialize" class="anchor"></a><code><span><span class="keyword">method</span> on_req_initialize : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../lsp/Lsp__/Types/Hover/index.html#type-t">Lsp.Types.Hover.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_initialize"><a href="#method-on_req_initialize" class="anchor"></a><code><span><span class="keyword">method</span> on_req_initialize : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/InitializeParams/index.html#type-t">Lsp.Types.InitializeParams.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/InitializeResult/index.html#type-t">Lsp.Types.InitializeResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_inlay_hint"><a href="#method-on_req_inlay_hint" class="anchor"></a><code><span><span class="keyword">method</span> on_req_inlay_hint : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../lsp/Lsp__/Types/InitializeResult/index.html#type-t">Lsp.Types.InitializeResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_inlay_hint"><a href="#method-on_req_inlay_hint" class="anchor"></a><code><span><span class="keyword">method</span> on_req_inlay_hint : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">range</span>:<a href="../../../../lsp/Lsp__/Types/Range/index.html#type-t">Lsp.Types.Range.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../lsp/Lsp__/Types/InlayHint/index.html#type-t">Lsp.Types.InlayHint.t</a> list</span> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_shutdown"><a href="#method-on_req_shutdown" class="anchor"></a><code><span><span class="keyword">method</span> on_req_shutdown : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_symbol"><a href="#method-on_req_symbol" class="anchor"></a><code><span><span class="keyword">method</span> on_req_symbol : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../lsp/Lsp__/Types/InlayHint/index.html#type-t">Lsp.Types.InlayHint.t</a> list</span> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_shutdown"><a href="#method-on_req_shutdown" class="anchor"></a><code><span><span class="keyword">method</span> on_req_shutdown : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_symbol"><a href="#method-on_req_symbol" class="anchor"></a><code><span><span class="keyword">method</span> on_req_symbol : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
|
|
@ -92,12 +92,12 @@
|
|||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'a</span> <a href="../../../../lsp/Lsp__/Client_request/index.html#type-t">Lsp.Client_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span><span>(<span class="type-var">'a</span>, string)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><span>(<span class="type-var">'a</span>, string)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'r</span> <a href="../../../../lsp/Lsp__/Client_request/index.html#type-t">Lsp.Client_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'r</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_notification"><a href="#method-on_unknown_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_notification : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'r</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_notification"><a href="#method-on_unknown_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_notification : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../jsonrpc/Jsonrpc/Notification/index.html#type-t">Jsonrpc.Notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_request"><a href="#method-on_unknown_request" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_request : <span><span class="label">notify_back</span>:<a href="../class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_request"><a href="#method-on_unknown_request" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_request : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<span>(<span><a href="../index.html#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc2 (linol-lwt.Linol_lwt.Jsonrpc2)</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">linol-lwt</a> » <a href="../index.html">Linol_lwt</a> » Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol_lwt.Jsonrpc2</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="IO/index.html">IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc2 (linol-lwt.Linol_lwt.Jsonrpc2)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol-lwt</a> » <a href="../index.html">Linol_lwt</a> » Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol_lwt.Jsonrpc2</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="IO/index.html">IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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> t</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Request ID.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
* <span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span> <a href="#type-server_request_handler_pair">server_request_handler_pair</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-send_request"><a href="#type-send_request" class="anchor"></a><code><span><span class="keyword">type</span> send_request</span><span> = <span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="Req_id/index.html#type-t">Req_id.t</a> <a href="IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-base_server"><a href="#class-base_server" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">virtual</span> </span><span><a href="class-base_server/index.html">base_server</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-async"><a href="#val-async" class="anchor"></a><code><span><span class="keyword">val</span> async : <span><a href="class-base_server/index.html">base_server</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-notify_back"><a href="#class-notify_back" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-notify_back/index.html">notify_back</a></span><span> : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="label">server_request</span>:<span>(<span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span>
|
||||
|
|
@ -9,12 +9,12 @@
|
|||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">ic</span>:<a href="IO/index.html#type-in_channel">IO.in_channel</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">oc</span>:<a href="IO/index.html#type-out_channel">IO.out_channel</a> <span class="arrow">-></span></span>
|
||||
<span><a href="class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</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-create_stdio"><a href="#val-create_stdio" class="anchor"></a><code><span><span class="keyword">val</span> create_stdio :
|
||||
<span><span class="optlabel">?on_received</span>:<span>(<span><a href="../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">env</span>:<a href="IO/index.html#type-env">IO.env</a> <span class="arrow">-></span></span>
|
||||
<span><a href="class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</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-send_server_notification"><a href="#val-send_server_notification" class="anchor"></a><code><span><span class="keyword">val</span> send_server_notification : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_server_request"><a href="#val-send_server_request" class="anchor"></a><code><span><span class="keyword">val</span> send_server_request :
|
||||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'from_server</span> <a href="../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,4 +1,9 @@
|
|||
|
||||
# 0.9
|
||||
|
||||
- Drop redundant dependency on atomic
|
||||
- Add support for lsp 1.22
|
||||
|
||||
# 0.8
|
||||
|
||||
- move to LSP 1.19 and 1.20
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (linol-lwt.index)</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> – linol-lwt</nav><header class="odoc-preamble"><h1 id="package-linol-lwt"><a href="#package-linol-lwt" class="anchor"></a>Package linol-lwt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Linol_lwt/index.html"><code>Linol_lwt</code></a> </li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (linol-lwt.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » linol-lwt</nav><header class="odoc-preamble"><h1 id="package-linol-lwt"><a href="#package-linol-lwt" class="anchor"></a>Package linol-lwt <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Linol_lwt/index.html"><code>Linol_lwt</code></a> </li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Jsonrpc2.Make.Req_id)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Req_id</span></code></h1></header><div class="odoc-content"><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</p><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="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Jsonrpc2.Make.Req_id)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Req_id</span></code></h1><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</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><span> = <a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Jsonrpc2.Make.base_server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Jsonrpc2.Make.base_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request"><a href="#method-on_request" class="anchor"></a><code><span><span class="keyword">method</span> on_request : 'a. <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Jsonrpc2.Make.notify_back)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Make.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Jsonrpc2.Make.notify_back)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Make.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_uri"><a href="#method-set_uri" class="anchor"></a><code><span><span class="keyword">method</span> set_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-telemetry"><a href="#method-telemetry" class="anchor"></a><code><span><span class="keyword">method</span> telemetry : <span><span class="xref-unresolved">Lsp__.Import.Json.t</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_begin"><a href="#method-work_done_progress_begin" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_begin : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressBegin/index.html#type-t">Lsp.Types.WorkDoneProgressBegin.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_end"><a href="#method-work_done_progress_end" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_end : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressEnd/index.html#type-t">Lsp.Types.WorkDoneProgressEnd.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_report"><a href="#method-work_done_progress_report" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_report : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressReport/index.html#type-t">Lsp.Types.WorkDoneProgressReport.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Jsonrpc2.Make.server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Jsonrpc2.Make.server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">Make</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `CodeActionOptions</span> of
|
||||
<a href="../../../../../lsp/Lsp__/Types/CodeActionOptions/index.html#type-t">Lsp.Types.CodeActionOptions.t</a></span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_lens_options"><a href="#method-config_code_lens_options" class="anchor"></a><code><span><span class="keyword">method</span> config_code_lens_options : <span><a href="../../../../../lsp/Lsp__/Types/CodeLensOptions/index.html#type-t">Lsp.Types.CodeLensOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_completion"><a href="#method-config_completion" class="anchor"></a><code><span><span class="keyword">method</span> config_completion : <span><a href="../../../../../lsp/Lsp__/Types/CompletionOptions/index.html#type-t">Lsp.Types.CompletionOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_definition"><a href="#method-config_definition" class="anchor"></a><code><span><span class="keyword">method</span> config_definition : <span><span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `DefinitionOptions</span> of
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (linol.Linol.Jsonrpc2.Make)</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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Jsonrpc2</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc2.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> IO</span><span> = <a href="argument-1-IO/index.html">IO</a></span></code></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> t</span></code></div><div class="spec-doc"><p>A jsonrpc2 connection.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (linol.Linol.Jsonrpc2.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Jsonrpc2</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Jsonrpc2.Make</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> IO</span><span> = <a href="argument-1-IO/index.html">IO</a></span></code></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> t</span></code></div><div class="spec-doc"><p>A jsonrpc2 connection.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Request ID.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
* <span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span> <a href="#type-server_request_handler_pair">server_request_handler_pair</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-send_request"><a href="#type-send_request" class="anchor"></a><code><span><span class="keyword">type</span> send_request</span><span> = <span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="Req_id/index.html#type-t">Req_id.t</a> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-base_server"><a href="#class-base_server" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">virtual</span> </span><span><a href="class-base_server/index.html">base_server</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-async"><a href="#val-async" class="anchor"></a><code><span><span class="keyword">val</span> async : <span><a href="class-base_server/index.html">base_server</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-notify_back"><a href="#class-notify_back" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-notify_back/index.html">notify_back</a></span><span> : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="label">server_request</span>:<span>(<span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span>
|
||||
|
|
@ -9,12 +9,12 @@
|
|||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">ic</span>:<a href="argument-1-IO/index.html#type-in_channel">IO.in_channel</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">oc</span>:<a href="argument-1-IO/index.html#type-out_channel">IO.out_channel</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../Linol__Jsonrpc2/module-type-S/class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Create a connection from the pair of channels</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_stdio"><a href="#val-create_stdio" class="anchor"></a><code><span><span class="keyword">val</span> create_stdio :
|
||||
<span><span class="optlabel">?on_received</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">env</span>:<a href="argument-1-IO/index.html#type-env">IO.env</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../Linol__Jsonrpc2/module-type-S/class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Create a connection using stdin/stdout</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_server_notification"><a href="#val-send_server_notification" class="anchor"></a><code><span><span class="keyword">val</span> send_server_notification : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send a notification from the server.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_server_request"><a href="#val-send_server_request" class="anchor"></a><code><span><span class="keyword">val</span> send_server_request :
|
||||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc2 (linol.Linol.Jsonrpc2)</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">linol</a> » <a href="../index.html">Linol</a> » Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol.Jsonrpc2</span></code></h1><p>Simple JSON-RPC2 implementation.</p><p>See <a href="https://www.jsonrpc.org/specification">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-json"><a href="#type-json" class="anchor"></a><code><span><span class="keyword">type</span> json</span><span> = <a href="../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-IO"><a href="#module-type-IO" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-IO/index.html">IO</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-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</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-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-IO/index.html">IO</a> : <a href="module-type-IO/index.html">IO</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/IO/index.html">IO</a> = <a href="Make/argument-1-IO/index.html">IO</a></span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Jsonrpc2 (linol.Linol.Jsonrpc2)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../index.html">Linol</a> » Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol.Jsonrpc2</span></code></h1><p>Simple JSON-RPC2 implementation.</p><p>See <a href="https://www.jsonrpc.org/specification">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-json"><a href="#type-json" class="anchor"></a><code><span><span class="keyword">type</span> json</span><span> = <a href="../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-IO"><a href="#module-type-IO" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-IO/index.html">IO</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-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</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-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-IO/index.html">IO</a> : <a href="module-type-IO/index.html">IO</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/IO/index.html">IO</a> = <a href="Make/argument-1-IO/index.html">IO</a></span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Jsonrpc2.S.Req_id)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>S.Req_id</span></code></h1></header><div class="odoc-content"><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</p><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="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Jsonrpc2.S.Req_id)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>S.Req_id</span></code></h1><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</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><span> = <a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Jsonrpc2.S.base_server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>S.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Jsonrpc2.S.base_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>S.base_server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request"><a href="#method-on_request" class="anchor"></a><code><span><span class="keyword">method</span> on_request : 'a. <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Jsonrpc2.S.notify_back)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>S.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Jsonrpc2.S.notify_back)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>S.notify_back</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_uri"><a href="#method-set_uri" class="anchor"></a><code><span><span class="keyword">method</span> set_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-telemetry"><a href="#method-telemetry" class="anchor"></a><code><span><span class="keyword">method</span> telemetry : <span><span class="xref-unresolved">Lsp__.Import.Json.t</span> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_begin"><a href="#method-work_done_progress_begin" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_begin : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressBegin/index.html#type-t">Lsp.Types.WorkDoneProgressBegin.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_end"><a href="#method-work_done_progress_end" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_end : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressEnd/index.html#type-t">Lsp.Types.WorkDoneProgressEnd.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_report"><a href="#method-work_done_progress_report" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_report : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressReport/index.html#type-t">Lsp.Types.WorkDoneProgressReport.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Jsonrpc2.S.server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>S.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Jsonrpc2.S.server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Jsonrpc2</a> » <a href="../index.html">S</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>S.server</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_action_provider"><a href="#method-config_code_action_provider" class="anchor"></a><code><span><span class="keyword">method</span> config_code_action_provider : <span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `CodeActionOptions</span> of
|
||||
<a href="../../../../../lsp/Lsp__/Types/CodeActionOptions/index.html#type-t">Lsp.Types.CodeActionOptions.t</a></span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_lens_options"><a href="#method-config_code_lens_options" class="anchor"></a><code><span><span class="keyword">method</span> config_code_lens_options : <span><a href="../../../../../lsp/Lsp__/Types/CodeLensOptions/index.html#type-t">Lsp.Types.CodeLensOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_completion"><a href="#method-config_completion" class="anchor"></a><code><span><span class="keyword">method</span> config_completion : <span><a href="../../../../../lsp/Lsp__/Types/CompletionOptions/index.html#type-t">Lsp.Types.CompletionOptions.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_definition"><a href="#method-config_definition" class="anchor"></a><code><span><span class="keyword">method</span> config_definition : <span><span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `DefinitionOptions</span> of
|
||||
|
|
@ -14,36 +14,36 @@
|
|||
<a href="../../../../../lsp/Lsp__/Types/ServerCapabilities/index.html#type-t">Lsp.Types.ServerCapabilities.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_symbol"><a href="#method-config_symbol" class="anchor"></a><code><span><span class="keyword">method</span> config_symbol : <span><span>[ <span>`Bool of bool</span>
|
||||
<span><span>| `DocumentSymbolOptions</span> of
|
||||
<a href="../../../../../lsp/Lsp__/Types/DocumentSymbolOptions/index.html#type-t">Lsp.Types.DocumentSymbolOptions.t</a></span> ]</span>
|
||||
option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_sync_opts"><a href="#method-config_sync_opts" class="anchor"></a><code><span><span class="keyword">method</span> config_sync_opts : <a href="../../../../../lsp/Lsp__/Types/TextDocumentSyncOptions/index.html#type-t">Lsp.Types.TextDocumentSyncOptions.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_change"><a href="#method-on_notif_doc_did_change" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_change : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_sync_opts"><a href="#method-config_sync_opts" class="anchor"></a><code><span><span class="keyword">method</span> config_sync_opts : <a href="../../../../../lsp/Lsp__/Types/TextDocumentSyncOptions/index.html#type-t">Lsp.Types.TextDocumentSyncOptions.t</a></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-must_quit"><a href="#method-must_quit" class="anchor"></a><code><span><span class="keyword">method</span> must_quit : bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_change"><a href="#method-on_notif_doc_did_change" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_change : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/VersionedTextDocumentIdentifier/index.html#type-t">Lsp.Types.VersionedTextDocumentIdentifier.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/TextDocumentContentChangeEvent/index.html#type-t">Lsp.Types.TextDocumentContentChangeEvent.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">old_content</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="label">new_content</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_close"><a href="#method-on_notif_doc_did_close" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_close : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_close"><a href="#method-on_notif_doc_did_close" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_close : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/TextDocumentIdentifier/index.html#type-t">Lsp.Types.TextDocumentIdentifier.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_open"><a href="#method-on_notif_doc_did_open" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_open : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_open"><a href="#method-on_notif_doc_did_open" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_open : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/TextDocumentItem/index.html#type-t">Lsp.Types.TextDocumentItem.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">content</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_save"><a href="#method-on_notif_doc_did_save" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_save : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notif_doc_did_save"><a href="#method-on_notif_doc_did_save" class="anchor"></a><code><span><span class="keyword">method</span> on_notif_doc_did_save : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/DidSaveTextDocumentParams/index.html#type-t">Lsp.Types.DidSaveTextDocumentParams.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_notification : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification_unhandled"><a href="#method-on_notification_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_notification_unhandled : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification_unhandled"><a href="#method-on_notification_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_notification_unhandled : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_action"><a href="#method-on_req_code_action" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_action : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_action"><a href="#method-on_req_code_action" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_action : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeActionParams/index.html#type-t">Lsp.Types.CodeActionParams.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeActionResult/index.html#type-t">Lsp.Types.CodeActionResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens"><a href="#method-on_req_code_lens" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeActionResult/index.html#type-t">Lsp.Types.CodeActionResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens"><a href="#method-on_req_code_lens" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">partialResultToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> list</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens_resolve"><a href="#method-on_req_code_lens_resolve" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens_resolve : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> list</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_code_lens_resolve"><a href="#method-on_req_code_lens_resolve" class="anchor"></a><code><span><span class="keyword">method</span> on_req_code_lens_resolve : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_completion"><a href="#method-on_req_completion" class="anchor"></a><code><span><span class="keyword">method</span> on_req_completion : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/CodeLens/index.html#type-t">Lsp.Types.CodeLens.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_completion"><a href="#method-on_req_completion" class="anchor"></a><code><span><span class="keyword">method</span> on_req_completion : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
|
|
@ -54,32 +54,32 @@
|
|||
<span><span><span>[ <span>`CompletionList of <span class="xref-unresolved">Lsp__.Types.CompletionList.t</span></span>
|
||||
<span><span>| `List</span> of <span><span class="xref-unresolved">Lsp__.Types.CompletionItem.t</span> list</span></span> ]</span>
|
||||
option</span>
|
||||
<a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_definition"><a href="#method-on_req_definition" class="anchor"></a><code><span><span class="keyword">method</span> on_req_definition : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_definition"><a href="#method-on_req_definition" class="anchor"></a><code><span><span class="keyword">method</span> on_req_definition : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">partialResultToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/Locations/index.html#type-t">Lsp.Types.Locations.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_execute_command"><a href="#method-on_req_execute_command" class="anchor"></a><code><span><span class="keyword">method</span> on_req_execute_command : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/Locations/index.html#type-t">Lsp.Types.Locations.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_execute_command"><a href="#method-on_req_execute_command" class="anchor"></a><code><span><span class="keyword">method</span> on_req_execute_command : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> list</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_hover"><a href="#method-on_req_hover" class="anchor"></a><code><span><span class="keyword">method</span> on_req_hover : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../yojson/Yojson__/Safe/index.html#type-t">Yojson.Safe.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_hover"><a href="#method-on_req_hover" class="anchor"></a><code><span><span class="keyword">method</span> on_req_hover : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">pos</span>:<span class="xref-unresolved">Lsp__Types.Position.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../index.html#type-doc_state">doc_state</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/Hover/index.html#type-t">Lsp.Types.Hover.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_initialize"><a href="#method-on_req_initialize" class="anchor"></a><code><span><span class="keyword">method</span> on_req_initialize : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><a href="../../../../../lsp/Lsp__/Types/Hover/index.html#type-t">Lsp.Types.Hover.t</a> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_initialize"><a href="#method-on_req_initialize" class="anchor"></a><code><span><span class="keyword">method</span> on_req_initialize : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/InitializeParams/index.html#type-t">Lsp.Types.InitializeParams.t</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/InitializeResult/index.html#type-t">Lsp.Types.InitializeResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_inlay_hint"><a href="#method-on_req_inlay_hint" class="anchor"></a><code><span><span class="keyword">method</span> on_req_inlay_hint : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Types/InitializeResult/index.html#type-t">Lsp.Types.InitializeResult.t</a> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_inlay_hint"><a href="#method-on_req_inlay_hint" class="anchor"></a><code><span><span class="keyword">method</span> on_req_inlay_hint : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">range</span>:<a href="../../../../../lsp/Lsp__/Types/Range/index.html#type-t">Lsp.Types.Range.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../../lsp/Lsp__/Types/InlayHint/index.html#type-t">Lsp.Types.InlayHint.t</a> list</span> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_shutdown"><a href="#method-on_req_shutdown" class="anchor"></a><code><span><span class="keyword">method</span> on_req_shutdown : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_symbol"><a href="#method-on_req_symbol" class="anchor"></a><code><span><span class="keyword">method</span> on_req_symbol : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><span><a href="../../../../../lsp/Lsp__/Types/InlayHint/index.html#type-t">Lsp.Types.InlayHint.t</a> list</span> option</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_shutdown"><a href="#method-on_req_shutdown" class="anchor"></a><code><span><span class="keyword">method</span> on_req_shutdown : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span> <span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_req_symbol"><a href="#method-on_req_symbol" class="anchor"></a><code><span><span class="keyword">method</span> on_req_symbol : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">uri</span>:<span class="xref-unresolved">Lsp__Types.DocumentUri.t</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">workDoneToken</span>:<span><span class="xref-unresolved">Lsp__Types.ProgressToken.t</span> option</span> <span class="arrow">-></span></span>
|
||||
|
|
@ -92,12 +92,12 @@
|
|||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'a</span> <a href="../../../../../lsp/Lsp__/Client_request/index.html#type-t">Lsp.Client_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span><span>(<span class="type-var">'a</span>, string)</span> <a href="../../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span><span>(<span class="type-var">'a</span>, string)</span> <a href="../../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'r</span> <a href="../../../../../lsp/Lsp__/Client_request/index.html#type-t">Lsp.Client_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'r</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_notification"><a href="#method-on_unknown_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_notification : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'r</span> <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_notification"><a href="#method-on_unknown_notification" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_notification : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../jsonrpc/Jsonrpc/Notification/index.html#type-t">Jsonrpc.Notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_request"><a href="#method-on_unknown_request" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_request : <span><span class="label">notify_back</span>:<a href="../../../../Linol__Jsonrpc2/module-type-S/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_unknown_request"><a href="#method-on_unknown_request" class="anchor"></a><code><span><span class="keyword">method</span> on_unknown_request : <span><span class="label">notify_back</span>:<span class="xref-unresolved">notify_back</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<span>(<span><a href="../index.html#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="../IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (linol.Linol.Jsonrpc2.S)</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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Jsonrpc2</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Jsonrpc2.S</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></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> t</span></code></div><div class="spec-doc"><p>A jsonrpc2 connection.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (linol.Linol.Jsonrpc2.S)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Jsonrpc2</a> » S</nav><header class="odoc-preamble"><h1>Module type <code><span>Jsonrpc2.S</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-IO"><a href="#module-IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></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> t</span></code></div><div class="spec-doc"><p>A jsonrpc2 connection.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Request ID.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
* <span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span> <a href="#type-server_request_handler_pair">server_request_handler_pair</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-send_request"><a href="#type-send_request" class="anchor"></a><code><span><span class="keyword">type</span> send_request</span><span> = <span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="Req_id/index.html#type-t">Req_id.t</a> <a href="IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-base_server"><a href="#class-base_server" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">virtual</span> </span><span><a href="class-base_server/index.html">base_server</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-async"><a href="#val-async" class="anchor"></a><code><span><span class="keyword">val</span> async : <span><a href="class-base_server/index.html">base_server</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-notify_back"><a href="#class-notify_back" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-notify_back/index.html">notify_back</a></span><span> : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="label">server_request</span>:<span>(<span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span>
|
||||
|
|
@ -9,12 +9,12 @@
|
|||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">ic</span>:<a href="IO/index.html#type-in_channel">IO.in_channel</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">oc</span>:<a href="IO/index.html#type-out_channel">IO.out_channel</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../Linol__Jsonrpc2/module-type-S/class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Create a connection from the pair of channels</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_stdio"><a href="#val-create_stdio" class="anchor"></a><code><span><span class="keyword">val</span> create_stdio :
|
||||
<span><span class="optlabel">?on_received</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?on_sent</span>:<span>(<span><a href="../index.html#type-json">json</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">env</span>:<a href="IO/index.html#type-env">IO.env</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../Linol__Jsonrpc2/module-type-S/class-server/index.html">server</a> <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">server</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Create a connection using stdin/stdout</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_server_notification"><a href="#val-send_server_notification" class="anchor"></a><code><span><span class="keyword">val</span> send_server_notification : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send a notification from the server.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_server_request"><a href="#val-send_server_request" class="anchor"></a><code><span><span class="keyword">val</span> send_server_request :
|
||||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Server.Make.base_server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.base_server</span></code></h1><p>The server baseclass</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">virtual</span> on_notification : <span><span class="label">notify_back</span>:
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>base_server (linol.Linol.Server.Make.base_server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » base_server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.base_server</span></code></h1><p>The server baseclass</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-on_notification"><a href="#method-on_notification" class="anchor"></a><code><span><span class="keyword">method</span> <span class="keyword">virtual</span> on_notification : <span><span class="label">notify_back</span>:
|
||||
<span>(<span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">server_request</span>:<a href="../index.html#type-send_request">send_request</a> <span class="arrow">-></span></span>
|
||||
<span><a href="../../../../../lsp/Lsp__/Client_notification/index.html#type-t">Lsp.Client_notification.t</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Server.Make.notify_back)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Make.notify_back</span></code></h1><p>A wrapper to more easily reply to notifications</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_uri"><a href="#method-set_uri" class="anchor"></a><code><span><span class="keyword">method</span> set_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send a log message to the editor</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send diagnostics for the current document</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-telemetry"><a href="#method-telemetry" class="anchor"></a><code><span><span class="keyword">method</span> telemetry : <span><span class="xref-unresolved">Lsp__.Import.Json.t</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_begin"><a href="#method-work_done_progress_begin" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_begin : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressBegin/index.html#type-t">Lsp.Types.WorkDoneProgressBegin.t</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>notify_back (linol.Linol.Server.Make.notify_back)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » notify_back</nav><header class="odoc-preamble"><h1>Class <code><span>Make.notify_back</span></code></h1><p>A wrapper to more easily reply to notifications</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-uri"><a href="#val-uri" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_uri"><a href="#method-set_uri" class="anchor"></a><code><span><span class="keyword">method</span> set_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_uri"><a href="#method-get_uri" class="anchor"></a><code><span><span class="keyword">method</span> get_uri : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_log_msg"><a href="#method-send_log_msg" class="anchor"></a><code><span><span class="keyword">method</span> send_log_msg : <span><span class="label">type_</span>:<span class="xref-unresolved">Lsp__Types.MessageType.t</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send a log message to the editor</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_diagnostic"><a href="#method-send_diagnostic" class="anchor"></a><code><span><span class="keyword">method</span> send_diagnostic : <span><span><a href="../../../../../lsp/Lsp__/Types/Diagnostic/index.html#type-t">Diagnostic.t</a> list</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send diagnostics for the current document</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-telemetry"><a href="#method-telemetry" class="anchor"></a><code><span><span class="keyword">method</span> telemetry : <span><span class="xref-unresolved">Lsp__.Import.Json.t</span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-cancel_request"><a href="#method-cancel_request" class="anchor"></a><code><span><span class="keyword">method</span> cancel_request : <span><a href="../../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_begin"><a href="#method-work_done_progress_begin" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_begin : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressBegin/index.html#type-t">Lsp.Types.WorkDoneProgressBegin.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_report"><a href="#method-work_done_progress_report" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_report : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressReport/index.html#type-t">Lsp.Types.WorkDoneProgressReport.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-work_done_progress_end"><a href="#method-work_done_progress_end" class="anchor"></a><code><span><span class="keyword">method</span> work_done_progress_end : <span><a href="../../../../../lsp/Lsp__/Types/WorkDoneProgressEnd/index.html#type-t">Lsp.Types.WorkDoneProgressEnd.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_notification"><a href="#method-send_notification" class="anchor"></a><code><span><span class="keyword">method</span> send_notification : <span><a href="../../../../../lsp/Lsp__/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Send a notification from the server to the client (general purpose method)</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-send_request"><a href="#method-send_request" class="anchor"></a><code><span><span class="keyword">method</span> send_request : 'from_server. <span><span><span class="type-var">'from_server</span> <a href="../../../../../lsp/Lsp__/Server_request/index.html#type-t">Lsp.Server_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span> <span>unit <a href="../argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Server.Make.server)</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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.server</span></code></h1><p>An easily overloadable class. Pick the methods you want to support. The user must provide at least the callbacks for document lifecycle: open, close, update. The most basic LSP server should check documents when they're updated and report diagnostics back to the editor.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-base_server/index.html">base_server</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div><div class="spec-doc"><p>Check if exit or shutdown request was made by the client.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5</li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div><div class="spec-doc"><p>Find current state of the given document, if present.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_positionEncoding"><a href="#method-set_positionEncoding" class="anchor"></a><code><span><span class="keyword">method</span> set_positionEncoding : <span><a href="../../../../../lsp/Lsp__/Types/InitializeParams/index.html#type-t">Lsp.Types.InitializeParams.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<a href="../../../../Linol__Server/Make/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>server (linol.Linol.Server.Make.server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../../index.html">Linol</a> » <a href="../../index.html">Server</a> » <a href="../index.html">Make</a> » server</nav><header class="odoc-preamble"><h1>Class <code><span>Make.server</span></code></h1><p>An easily overloadable class. Pick the methods you want to support. The user must provide at least the callbacks for document lifecycle: open, close, update. The most basic LSP server should check documents when they're updated and report diagnostics back to the editor.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <a href="../class-base_server/index.html">base_server</a></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-status"><a href="#val-status" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-positionEncoding"><a href="#val-positionEncoding" class="anchor"></a><code><span><span class="keyword">val</span> <span class="keyword">mutable</span> positionEncoding : <span>[ `UTF16 <span>| `UTF8</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value instance-variable anchored" id="val-docs"><a href="#val-docs" class="anchor"></a><code><span><span class="keyword">val</span> docs : <span><span>(<a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>, <a href="../index.html#type-doc_state">doc_state</a>)</span> <a href="../../../../../ocaml/Stdlib/Hashtbl/index.html#type-t">Hashtbl.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-get_status"><a href="#method-get_status" class="anchor"></a><code><span><span class="keyword">method</span> get_status : <span>[ `ReceivedExit <span>| `ReceivedShutdown</span> <span>| `Running</span> ]</span></span></code></div><div class="spec-doc"><p>Check if exit or shutdown request was made by the client.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5</li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-find_doc"><a href="#method-find_doc" class="anchor"></a><code><span><span class="keyword">method</span> find_doc : <span><a href="../../../../../lsp/Lsp__/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-doc_state">doc_state</a> option</span></span></code></div><div class="spec-doc"><p>Find current state of the given document, if present.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-set_positionEncoding"><a href="#method-set_positionEncoding" class="anchor"></a><code><span><span class="keyword">method</span> set_positionEncoding : <span><a href="../../../../../lsp/Lsp__/Types/InitializeParams/index.html#type-t">Lsp.Types.InitializeParams.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-on_request_unhandled"><a href="#method-on_request_unhandled" class="anchor"></a><code><span><span class="keyword">method</span> on_request_unhandled : 'r. <span><span class="label">notify_back</span>:<a href="../../../../Linol__Server/Make/class-notify_back/index.html">notify_back</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">id</span>:<a href="../../Req_id/index.html#type-t">Req_id.t</a> <span class="arrow">-></span></span>
|
||||
<span><span><span class="type-var">'r</span> <a href="../../../../../lsp/Lsp__/Client_request/index.html#type-t">Lsp.Client_request.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span class="type-var">'r</span> <a href="../argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>Override to process other requests</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_sync_opts"><a href="#method-config_sync_opts" class="anchor"></a><code><span><span class="keyword">method</span> config_sync_opts : <a href="../../../../../lsp/Lsp__/Types/TextDocumentSyncOptions/index.html#type-t">Lsp.Types.TextDocumentSyncOptions.t</a></span></code></div><div class="spec-doc"><p>Parameter for how to synchronize content with the editor</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_completion"><a href="#method-config_completion" class="anchor"></a><code><span><span class="keyword">method</span> config_completion : <span><a href="../../../../../lsp/Lsp__/Types/CompletionOptions/index.html#type-t">Lsp.Types.CompletionOptions.t</a> option</span></span></code></div><div class="spec-doc"><p>Configuration for the completion API.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.4</li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_code_lens_options"><a href="#method-config_code_lens_options" class="anchor"></a><code><span><span class="keyword">method</span> config_code_lens_options : <span><a href="../../../../../lsp/Lsp__/Types/CodeLensOptions/index.html#type-t">Lsp.Types.CodeLensOptions.t</a> option</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-config_definition"><a href="#method-config_definition" class="anchor"></a><code><span><span class="keyword">method</span> config_definition : <span><span>[ <span>`Bool of bool</span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (linol.Linol.Server.Make)</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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Server</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Server.Make</span></code></h1><p>Server interface for some IO substrate.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> Req_id</span><span> = <a href="../Req_id/index.html">Req_id</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (linol.Linol.Server.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Server</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Server.Make</span></code></h1><p>Server interface for some IO substrate.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Position"><a href="#module-Position" class="anchor"></a><code><span><span class="keyword">module</span> Position</span><span> = <a href="../../../../lsp/Lsp/Types/Position/index.html">Lsp.Types.Position</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span><span class="keyword">module</span> Range</span><span> = <a href="../../../../lsp/Lsp/Types/Range/index.html">Lsp.Types.Range</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> Diagnostic</span><span> = <a href="../../../../lsp/Lsp/Types/Diagnostic/index.html">Lsp.Types.Diagnostic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-DiagnosticSeverity"><a href="#module-DiagnosticSeverity" class="anchor"></a><code><span><span class="keyword">module</span> DiagnosticSeverity</span><span> = <a href="../../../../lsp/Lsp/Types/DiagnosticSeverity/index.html">Lsp.Types.DiagnosticSeverity</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> Req_id</span><span> = <a href="../Req_id/index.html">Req_id</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_request_handler_pair"><a href="#type-server_request_handler_pair" class="anchor"></a><code><span><span class="keyword">type</span> server_request_handler_pair</span><span> = </span></code><ol><li id="type-server_request_handler_pair.Request_and_handler" class="def variant constructor anchored"><a href="#type-server_request_handler_pair.Request_and_handler" class="anchor"></a><code><span>| </span><span><span class="constructor">Request_and_handler</span> : <span><span class="type-var">'from_server</span> <a href="../../../../lsp/Lsp/Server_request/index.html#type-t">Lsp.Server_request.t</a></span>
|
||||
* <span>(<span><span><span>(<span class="type-var">'from_server</span>, <a href="../../../../jsonrpc/Jsonrpc/Response/Error/index.html#type-t">Jsonrpc.Response.Error.t</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span> <a href="#type-server_request_handler_pair">server_request_handler_pair</a></span></code></li></ol></div><div class="spec-doc"><p>A variant carrying a <code>Lsp.Server_request.t</code> and a handler for its return value. The request is stored in order to allow us to discriminate its existential variable.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-send_request"><a href="#type-send_request" class="anchor"></a><code><span><span class="keyword">type</span> send_request</span><span> = <span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span> <span><a href="../Req_id/index.html#type-t">Req_id.t</a> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div><div class="spec-doc"><p>The type of the action that sends a request from the server to the client and handles its response.</p></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-base_server"><a href="#class-base_server" class="anchor"></a><code><span><span class="keyword">class</span> <span class="keyword">virtual</span> </span><span><a href="class-base_server/index.html">base_server</a></span><span> : <span class="keyword">object</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The server baseclass</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-async"><a href="#val-async" class="anchor"></a><code><span><span class="keyword">val</span> async : <span><a href="class-base_server/index.html">base_server</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec class anchored" id="class-notify_back"><a href="#class-notify_back" class="anchor"></a><code><span><span class="keyword">class</span> </span><span><a href="class-notify_back/index.html">notify_back</a></span><span> : <span><span class="label">notify_back</span>:<span>(<span><a href="../../../../lsp/Lsp/Server_notification/index.html#type-t">Lsp.Server_notification.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <a href="argument-1-IO/index.html#type-t">IO.t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="label">server_request</span>:<span>(<span><a href="#type-server_request_handler_pair">server_request_handler_pair</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Server.Req_id)</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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Server</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Server.Req_id</span></code></h1><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</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><span> = <a href="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Req_id (linol.Linol.Server.Req_id)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../../index.html">Linol</a> » <a href="../index.html">Server</a> » Req_id</nav><header class="odoc-preamble"><h1>Module <code><span>Server.Req_id</span></code></h1><p>Request ID.</p><p>The unique ID of a request, used by JSONRPC to map each request to its reply.</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><span> = <a href="../../../../jsonrpc/Jsonrpc/Id/index.html#type-t">Jsonrpc.Id.t</a></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 class="spec-doc"><p>String representation of the ID</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Server (linol.Linol.Server)</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">linol</a> » <a href="../index.html">Linol</a> » Server</nav><header class="odoc-preamble"><h1>Module <code><span>Linol.Server</span></code></h1><p>Server interface</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-doc_state"><a href="#type-doc_state" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> doc_state</span><span> = </span><span>{</span></code><ol><li id="type-doc_state.uri" class="def record field anchored"><a href="#type-doc_state.uri" class="anchor"></a><code><span>uri : <a href="../../../lsp/Lsp/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>;</span></code></li><li id="type-doc_state.languageId" class="def record field anchored"><a href="#type-doc_state.languageId" class="anchor"></a><code><span>languageId : string;</span></code></li><li id="type-doc_state.version" class="def record field anchored"><a href="#type-doc_state.version" class="anchor"></a><code><span>version : int;</span></code></li><li id="type-doc_state.content" class="def record field anchored"><a href="#type-doc_state.content" class="anchor"></a><code><span>content : string;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Current state of a document.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Request ID.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-IO/index.html">IO</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Server interface for some IO substrate.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Server (linol.Linol.Server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » <a href="../index.html">Linol</a> » Server</nav><header class="odoc-preamble"><h1>Module <code><span>Linol.Server</span></code></h1><p>Server interface</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-doc_state"><a href="#type-doc_state" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> doc_state</span><span> = </span><span>{</span></code><ol><li id="type-doc_state.uri" class="def record field anchored"><a href="#type-doc_state.uri" class="anchor"></a><code><span>uri : <a href="../../../lsp/Lsp/Types/DocumentUri/index.html#type-t">Lsp.Types.DocumentUri.t</a>;</span></code></li><li id="type-doc_state.languageId" class="def record field anchored"><a href="#type-doc_state.languageId" class="anchor"></a><code><span>languageId : string;</span></code></li><li id="type-doc_state.version" class="def record field anchored"><a href="#type-doc_state.version" class="anchor"></a><code><span>version : int;</span></code></li><li id="type-doc_state.content" class="def record field anchored"><a href="#type-doc_state.content" class="anchor"></a><code><span>content : string;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Current state of a document.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Req_id"><a href="#module-Req_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Req_id/index.html">Req_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Request ID.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-IO/index.html">IO</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Server interface for some IO substrate.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol (linol.Linol)</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">linol</a> » Linol</nav><header class="odoc-preamble"><h1>Module <code><span>Linol</span></code></h1><p>Linol.</p><p>Abstraction over The "Lsp" library, to make it easier to develop LSP servers in OCaml (but not necessarily <b>for</b> OCaml).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-IO"><a href="#module-type-IO" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-IO/index.html">IO</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-Jsonrpc2"><a href="#module-Jsonrpc2" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Jsonrpc2/index.html">Jsonrpc2</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Simple JSON-RPC2 implementation.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Server"><a href="#module-Server" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Server/index.html">Server</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Server interface</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Blocking_IO"><a href="#module-Blocking_IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Blocking_IO/index.html">Blocking_IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Blocking IO with a new thread for each <code>spawn</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Log"><a href="#module-Log" class="anchor"></a><code><span><span class="keyword">module</span> Log</span><span> = <a href="Log/index.html">Log</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> Make</span><span> = <a href="Jsonrpc2/Make/index.html">Jsonrpc2.Make</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-logs_src"><a href="#val-logs_src" class="anchor"></a><code><span><span class="keyword">val</span> logs_src : <a href="../../logs/Logs/index.html#type-src">Logs.src</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol (linol.Linol)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol</nav><header class="odoc-preamble"><h1>Module <code><span>Linol</span></code></h1><p>Linol.</p><p>Abstraction over The "Lsp" library, to make it easier to develop LSP servers in OCaml (but not necessarily <b>for</b> OCaml).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-IO"><a href="#module-type-IO" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-IO/index.html">IO</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-Jsonrpc2"><a href="#module-Jsonrpc2" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Jsonrpc2/index.html">Jsonrpc2</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Simple JSON-RPC2 implementation.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Server"><a href="#module-Server" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Server/index.html">Server</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Server interface</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Blocking_IO"><a href="#module-Blocking_IO" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Blocking_IO/index.html">Blocking_IO</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Blocking IO with a new thread for each <code>spawn</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Log"><a href="#module-Log" class="anchor"></a><code><span><span class="keyword">module</span> Log</span><span> = <a href="Log/index.html">Log</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> Make</span><span> = <a href="Jsonrpc2/Make/index.html">Jsonrpc2.Make</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-logs_src"><a href="#val-logs_src" class="anchor"></a><code><span><span class="keyword">val</span> logs_src : <a href="../../logs/Logs/index.html#type-src">Logs.src</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__ (linol.Linol__)</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">linol</a> » Linol__</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__ (linol.Linol__)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Blocking_IO (linol.Linol__Blocking_IO)</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">linol</a> » Linol__Blocking_IO</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Blocking_IO</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Blocking_IO (linol.Linol__Blocking_IO)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__Blocking_IO</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Blocking_IO</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Common_ (linol.Linol__Common_)</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">linol</a> » Linol__Common_</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Common_</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Common_ (linol.Linol__Common_)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__Common_</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Common_</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Jsonrpc2 (linol.Linol__Jsonrpc2)</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">linol</a> » Linol__Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Jsonrpc2</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Jsonrpc2 (linol.Linol__Jsonrpc2)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__Jsonrpc2</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Jsonrpc2</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Server (linol.Linol__Server)</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">linol</a> » Linol__Server</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Server</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Server (linol.Linol__Server)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__Server</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Server</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Sigs (linol.Linol__Sigs)</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">linol</a> » Linol__Sigs</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Sigs</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linol__Sigs (linol.Linol__Sigs)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">linol</a> » Linol__Sigs</nav><header class="odoc-preamble"><h1>Module <code><span>Linol__Sigs</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,9 @@
|
|||
|
||||
# 0.9
|
||||
|
||||
- Drop redundant dependency on atomic
|
||||
- Add support for lsp 1.22
|
||||
|
||||
# 0.8
|
||||
|
||||
- move to LSP 1.19 and 1.20
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (linol.index)</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> – linol</nav><header class="odoc-preamble"><h1 id="package-linol"><a href="#package-linol" class="anchor"></a>Package linol <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Linol/index.html"><code>Linol</code></a> <span class="synopsis">Linol.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (linol.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » linol</nav><header class="odoc-preamble"><h1 id="package-linol"><a href="#package-linol" class="anchor"></a>Package linol <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Linol/index.html"><code>Linol</code></a> <span class="synopsis">Linol.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tag (logs.Logs.Tag)</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">logs</a> » <a href="../index.html">Logs</a> » Tag</nav><header class="odoc-preamble"><h1>Module <code><span>Logs.Tag</span></code></h1><p>Message tags.</p><p>Message tags are arbitrary named and typed values that can be associated to log messages. See an <a href="../index.html#ex1" title="ex1">example</a>.</p></header><nav class="odoc-toc"><ul><li><a href="#tag-definitions">Tag definitions</a></li><li><a href="#tags">Tags</a></li><li><a href="#tag-sets">Tag sets</a></li></ul></nav><div class="odoc-content"><h2 id="tag-definitions"><a href="#tag-definitions" class="anchor"></a>Tag definitions</h2><div class="odoc-spec"><div class="spec type anchored" id="type-def"><a href="#type-def" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a def</span></span></code></div><div class="spec-doc"><p>The type for tag definitions. The type <code>'a</code> is the type of the tag. The definition specifies a name for the tag, a pretty-printer for the type of the tag and a documentation string. See <a href="#val-def"><code>def</code></a>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-def_e"><a href="#type-def_e" class="anchor"></a><code><span><span class="keyword">type</span> def_e</span><span> = </span></code><ol><li id="type-def_e.Def" class="def variant constructor anchored"><a href="#type-def_e.Def" class="anchor"></a><code><span>| </span><span><span class="constructor">Def</span> : <span><span class="type-var">'a</span> <a href="#type-def">def</a></span> <span class="arrow">-></span> <a href="#type-def_e">def_e</a></span></code></li></ol></div><div class="spec-doc"><p>The type for existential tag definitions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-def"><a href="#val-def" class="anchor"></a><code><span><span class="keyword">val</span> def :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tag (logs.Logs.Tag)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » <a href="../index.html">Logs</a> » Tag</nav><header class="odoc-preamble"><h1>Module <code><span>Logs.Tag</span></code></h1><p>Message tags.</p><p>Message tags are arbitrary named and typed values that can be associated to log messages. See an <a href="../index.html#ex1" title="ex1">example</a>.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#tag-definitions">Tag definitions</a></li><li><a href="#tags">Tags</a></li><li><a href="#tag-sets">Tag sets</a></li></ul></nav></div><div class="odoc-content"><h2 id="tag-definitions"><a href="#tag-definitions" class="anchor"></a>Tag definitions</h2><div class="odoc-spec"><div class="spec type anchored" id="type-def"><a href="#type-def" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a def</span></span></code></div><div class="spec-doc"><p>The type for tag definitions. The type <code>'a</code> is the type of the tag. The definition specifies a name for the tag, a pretty-printer for the type of the tag and a documentation string. See <a href="#val-def"><code>def</code></a>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-def_e"><a href="#type-def_e" class="anchor"></a><code><span><span class="keyword">type</span> def_e</span><span> = </span></code><ol><li id="type-def_e.Def" class="def variant constructor anchored"><a href="#type-def_e.Def" class="anchor"></a><code><span>| </span><span><span class="constructor">Def</span> : <span><span class="type-var">'a</span> <a href="#type-def">def</a></span> <span class="arrow">-></span> <a href="#type-def_e">def_e</a></span></code></li></ol></div><div class="spec-doc"><p>The type for existential tag definitions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-def"><a href="#val-def" class="anchor"></a><code><span><span class="keyword">val</span> def :
|
||||
<span><span class="optlabel">?doc</span>:string <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></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> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LOG (logs.Logs.LOG)</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">logs</a> » <a href="../index.html">Logs</a> » LOG</nav><header class="odoc-preamble"><h1>Module type <code><span>Logs.LOG</span></code></h1><p>The type for source specific logging functions.</p></header><nav class="odoc-toc"><ul><li><a href="#func">Log functions</a><ul><li><a href="#result">Logging <code>result</code> value <code>Error</code>s</a></li></ul></li></ul></nav><div class="odoc-content"><h2 id="func"><a href="#func" class="anchor"></a>Log functions</h2><div class="odoc-spec"><div class="spec value anchored" id="val-msg"><a href="#val-msg" class="anchor"></a><code><span><span class="keyword">val</span> msg : <span><a href="../index.html#type-level">level</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../index.html#val-msg"><code>Logs.msg</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-app"><a href="#val-app" class="anchor"></a><code><span><span class="keyword">val</span> app : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>app</code> is <code>msg App</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err"><a href="#val-err" class="anchor"></a><code><span><span class="keyword">val</span> err : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>err</code> is <code>msg Error</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn"><a href="#val-warn" class="anchor"></a><code><span><span class="keyword">val</span> warn : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>warn</code> is <code>msg Warning</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>info</code> is <code>msg Info</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug"><a href="#val-debug" class="anchor"></a><code><span><span class="keyword">val</span> debug : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>debug</code> is <code>msg Debug</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kmsg"><a href="#val-kmsg" class="anchor"></a><code><span><span class="keyword">val</span> kmsg : <span><span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><a href="../index.html#type-level">level</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-msgf">msgf</a></span> <span class="arrow">-></span></span> <span class="type-var">'b</span></span></code></div><div class="spec-doc"><p>See <a href="../index.html#val-kmsg"><code>Logs.kmsg</code></a>.</p></div></div><h3 id="result"><a href="#result" class="anchor"></a>Logging <code>result</code> value <code>Error</code>s</h3><div class="odoc-spec"><div class="spec value anchored" id="val-on_error"><a href="#val-on_error" class="anchor"></a><code><span><span class="keyword">val</span> on_error :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LOG (logs.Logs.LOG)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » <a href="../index.html">Logs</a> » LOG</nav><header class="odoc-preamble"><h1>Module type <code><span>Logs.LOG</span></code></h1><p>The type for source specific logging functions.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#func">Log functions</a><ul><li><a href="#result">Logging <code>result</code> value <code>Error</code>s</a></li></ul></li></ul></nav></div><div class="odoc-content"><h2 id="func"><a href="#func" class="anchor"></a>Log functions</h2><div class="odoc-spec"><div class="spec value anchored" id="val-msg"><a href="#val-msg" class="anchor"></a><code><span><span class="keyword">val</span> msg : <span><a href="../index.html#type-level">level</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../index.html#val-msg"><code>Logs.msg</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-app"><a href="#val-app" class="anchor"></a><code><span><span class="keyword">val</span> app : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>app</code> is <code>msg App</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err"><a href="#val-err" class="anchor"></a><code><span><span class="keyword">val</span> err : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>err</code> is <code>msg Error</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn"><a href="#val-warn" class="anchor"></a><code><span><span class="keyword">val</span> warn : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>warn</code> is <code>msg Warning</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>info</code> is <code>msg Info</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug"><a href="#val-debug" class="anchor"></a><code><span><span class="keyword">val</span> debug : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p><code>debug</code> is <code>msg Debug</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kmsg"><a href="#val-kmsg" class="anchor"></a><code><span><span class="keyword">val</span> kmsg : <span><span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><a href="../index.html#type-level">level</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-msgf">msgf</a></span> <span class="arrow">-></span></span> <span class="type-var">'b</span></span></code></div><div class="spec-doc"><p>See <a href="../index.html#val-kmsg"><code>Logs.kmsg</code></a>.</p></div></div><h3 id="result"><a href="#result" class="anchor"></a>Logging <code>result</code> value <code>Error</code>s</h3><div class="odoc-spec"><div class="spec value anchored" id="val-on_error"><a href="#val-on_error" class="anchor"></a><code><span><span class="keyword">val</span> on_error :
|
||||
<span><span class="optlabel">?level</span>:<a href="../index.html#type-level">level</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?header</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?tags</span>:<a href="../Tag/index.html#type-set">Tag.set</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,26 +1,35 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_cli (logs.Logs_cli)</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">logs</a> » Logs_cli</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_cli</span></code></h1><p><a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <a href="../Logs/index.html"><code>Logs</code></a>.</p><p>See a full <a href="#ex" title="ex">example</a>.</p><p><em>v0.7.0 - <a href="https://erratique.ch/software/logs">homepage</a></em></p></header><nav class="odoc-toc"><ul><li><a href="#options-for-setting-the-report-level">Options for setting the report level</a></li><li><a href="#ex">Example</a></li></ul></nav><div class="odoc-content"><h2 id="options-for-setting-the-report-level"><a href="#options-for-setting-the-report-level" class="anchor"></a>Options for setting the report level</h2><div class="odoc-spec"><div class="spec value anchored" id="val-level"><a href="#val-level" class="anchor"></a><code><span><span class="keyword">val</span> level :
|
||||
<span><span class="optlabel">?env</span>:<a href="../../cmdliner/Cmdliner/Arg/index.html#type-env">Cmdliner.Arg.env</a> <span class="arrow">-></span></span>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_cli (logs.Logs_cli)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » Logs_cli</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_cli</span></code></h1><p><a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <a href="../Logs/index.html"><code>Logs</code></a>.</p><p>See a full <a href="#ex" title="ex">example</a>.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#options-for-setting-the-report-level">Options for setting the report level</a></li><li><a href="#ex">Example</a></li></ul></nav></div><div class="odoc-content"><h2 id="options-for-setting-the-report-level"><a href="#options-for-setting-the-report-level" class="anchor"></a>Options for setting the report level</h2><div class="odoc-spec"><div class="spec value anchored" id="val-level"><a href="#val-level" class="anchor"></a><code><span><span class="keyword">val</span> level :
|
||||
<span><span class="optlabel">?env</span>:<a href="../../cmdliner/Cmdliner/Cmd/Env/index.html#type-info">Cmdliner.Cmd.Env.info</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?docs</span>:string <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span><span><a href="../Logs/index.html#type-level">Logs.level</a> option</span> <a href="../../cmdliner/Cmdliner/Term/index.html#type-t">Cmdliner.Term.t</a></span></span></code></div><div class="spec-doc"><p><code>level ?env ?docs ()</code> is a term for three <a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> options that can be used with <a href="../Logs/index.html#val-set_level"><code>Logs.set_level</code></a>. The options are documented under <code>docs</code> (defaults to the default of <a href="../../cmdliner/Cmdliner/Arg/index.html#type-info"><code>Cmdliner.Arg.info</code></a>).</p><p>The options work as follows:</p><ul><li><code>-v</code> or <code>--verbose</code>, if it appears once, the value of the term is is <code>Some Logs.Info</code> and more than once <code>Some Logs.Debug</code>.</li><li><code>--verbosity=LEVEL</code>, the value of the term is <code>l</code> where <code>l</code> depends on on <code>LEVEL</code>. Takes over the option <code>-v</code>.</li><li><code>-q</code> or <code>--quiet</code>, the value of the term is <code>None</code>. Takes over the <code>-v</code> and <code>--verbosity</code> options.</li><li>If both options are absent the default value is <code>Some Logs.warning</code></li></ul><p>If <code>env</code> is provided, the default value in case all options are absent can be overridden by the corresponding environment variable.</p></div></div><h2 id="ex"><a href="#ex" class="anchor"></a>Example</h2><p>The following example shows how to setup <a href="../Logs/index.html"><code>Logs</code></a> and <a href="../../fmt/Fmt/index.html"><code>Fmt</code></a> so that logging is performed on standard outputs with ANSI coloring if these are <code>tty</code>s. The command line interface provides options to control the use of colors and the log reporting level.</p><pre class="language-ocaml"><code>let hello () = Logs.app (fun m -> m "Hello horrible world!")
|
||||
<span><span><a href="../Logs/index.html#type-level">Logs.level</a> option</span> <a href="../../cmdliner/Cmdliner/Term/index.html#type-t">Cmdliner.Term.t</a></span></span></code></div><div class="spec-doc"><p><code>level ?env ?docs ()</code> is a term for three <a href="../../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> options that can be used with <a href="../Logs/index.html#val-set_level"><code>Logs.set_level</code></a>. The options are documented under <code>docs</code> (defaults to the default of <a href="../../cmdliner/Cmdliner/Arg/index.html#type-info"><code>Cmdliner.Arg.info</code></a>).</p><p>The options work as follows:</p><ul><li><code>-v</code> or <code>--verbose</code>, if it appears once, the value of the term is <code>Some Logs.Info</code> and more than once <code>Some Logs.Debug</code>.</li><li><code>--verbosity=LEVEL</code>, the value of the term is <code>l</code> where <code>l</code> depends on on <code>LEVEL</code>. Takes over the option <code>-v</code>.</li><li><code>-q</code> or <code>--quiet</code>, the value of the term is <code>None</code>. Takes over the <code>-v</code> and <code>--verbosity</code> options.</li><li>If both options are absent the default value is <code>Some Logs.warning</code></li></ul><p>If <code>env</code> is provided, the default value in case all options are absent can be overridden by the corresponding environment variable.</p></div></div><h2 id="ex"><a href="#ex" class="anchor"></a>Example</h2><p>The following example shows how to setup <a href="../Logs/index.html"><code>Logs</code></a> and <a href="../../fmt/Fmt/index.html"><code>Fmt</code></a> so that logging is performed on standard outputs with ANSI coloring if these are <code>tty</code>s. The command line interface provides options to control the use of colors and the log reporting level.</p><pre class="language-ocaml"><code>let hello _ msg =
|
||||
Logs.app (fun m -> m "%s" msg);
|
||||
Logs.info (fun m -> m "End-user information.");
|
||||
Logs.debug (fun m -> m "Developer information.");
|
||||
Logs.err (fun m -> m "Something bad happened.");
|
||||
Logs.warn (fun m -> m "Something bad may happen in the future.");
|
||||
if Logs.err_count () > 0 then 1 else 0
|
||||
|
||||
let setup_log style_renderer level =
|
||||
Fmt_tty.setup_std_outputs ?style_renderer ();
|
||||
Logs.set_level level;
|
||||
Logs.set_reporter (Logs_fmt.reporter ());
|
||||
()
|
||||
Logs.set_reporter (Logs_fmt.reporter ())
|
||||
|
||||
(* Command line interface *)
|
||||
|
||||
open Cmdliner
|
||||
|
||||
let setup_log =
|
||||
Term.(const setup_log $ Fmt_cli.style_renderer () $ Logs_cli.level ())
|
||||
let env = Cmd.Env.info "TOOL_VERBOSITY" in
|
||||
Term.(const setup_log $ Fmt_cli.style_renderer () $ Logs_cli.level ~env ())
|
||||
|
||||
let msg =
|
||||
let doc = "The message to output." in
|
||||
Arg.(value & pos 0 string "Hello horrible world!" & info [] ~doc)
|
||||
|
||||
let main () =
|
||||
match Term.(eval (const hello $ setup_log, Term.info "tool")) with
|
||||
| `Error _ -> exit 1
|
||||
| _ -> exit (if Logs.err_count () > 0 then 1 else 0)
|
||||
let cmd = Cmd.make (Cmd.info "tool") Term.(const hello $ setup_log $ msg) in
|
||||
Cmd.eval' cmd
|
||||
|
||||
let () = main ()</code></pre></div></body></html>
|
||||
let () = if !Sys.interactive then () else exit (main ())</code></pre></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_fmt (logs.Logs_fmt)</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">logs</a> » Logs_fmt</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_fmt</span></code></h1><p><code>Format</code> colorful reporter for <a href="../Logs/index.html"><code>Logs</code></a>.</p><p><em>v0.7.0 - <a href="https://erratique.ch/software/logs">homepage</a></em></p></header><nav class="odoc-toc"><ul><li><a href="#reporter">Reporter</a></li><li><a href="#cheader">Colored message headers</a></li></ul></nav><div class="odoc-content"><h2 id="reporter"><a href="#reporter" class="anchor"></a>Reporter</h2><div class="odoc-spec"><div class="spec value anchored" id="val-reporter"><a href="#val-reporter" class="anchor"></a><code><span><span class="keyword">val</span> reporter :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_fmt (logs.Logs_fmt)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » Logs_fmt</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_fmt</span></code></h1><p><code>Format</code> colorful reporter for <a href="../Logs/index.html"><code>Logs</code></a>.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#reporter">Reporter</a></li><li><a href="#cheader">Colored message headers</a></li></ul></nav></div><div class="odoc-content"><h2 id="reporter"><a href="#reporter" class="anchor"></a>Reporter</h2><div class="odoc-spec"><div class="spec value anchored" id="val-reporter"><a href="#val-reporter" class="anchor"></a><code><span><span class="keyword">val</span> reporter :
|
||||
<span><span class="optlabel">?pp_header</span>:<span><span>(<a href="../Logs/index.html#type-level">Logs.level</a> * <span>string option</span>)</span> <a href="../../fmt/Fmt/index.html#type-t">Fmt.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?app</span>:<a href="../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?dst</span>:<a href="../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<a href="../Logs/index.html#type-reporter">Logs.reporter</a></span></code></div><div class="spec-doc"><p><code>reporter</code> is like <a href="../Logs/index.html#val-format_reporter"><code>Logs.format_reporter</code></a> except ANSI colors may be used in message header rendering if the formatters are configured to do so; see <a href="../../fmt/Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a> and <a href="../../fmt/Fmt_tty/index.html"><code>Fmt_tty</code></a>.</p><p>Consult a full command line <a href="../Logs_cli/index.html#ex" title="ex">setup example</a>.</p></div></div><h2 id="cheader"><a href="#cheader" class="anchor"></a>Colored message headers</h2><div class="odoc-spec"><div class="spec value anchored" id="val-app_style"><a href="#val-app_style" class="anchor"></a><code><span><span class="keyword">val</span> app_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>app_style</code> is the style used to render headers at app level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err_style"><a href="#val-err_style" class="anchor"></a><code><span><span class="keyword">val</span> err_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>err_style</code> is the style used to render headers at error level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn_style"><a href="#val-warn_style" class="anchor"></a><code><span><span class="keyword">val</span> warn_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>warn_style</code> is the style used to render headers at warning level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_style"><a href="#val-info_style" class="anchor"></a><code><span><span class="keyword">val</span> info_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>info_style</code> is the style used to render headers at info level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug_style"><a href="#val-debug_style" class="anchor"></a><code><span><span class="keyword">val</span> debug_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>debug_style</code> is the style used to render headers at debug level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_header"><a href="#val-pp_header" class="anchor"></a><code><span><span class="keyword">val</span> pp_header : <span><span>(<a href="../Logs/index.html#type-level">Logs.level</a> * <span>string option</span>)</span> <a href="../../fmt/Fmt/index.html#type-t">Fmt.t</a></span></span></code></div><div class="spec-doc"><p><code>pp_header</code> is like <a href="../Logs/index.html#val-pp_header"><code>Logs.pp_header</code></a> but may use ANSI colors if the formatter is configured to do so, see <a href="../../fmt/Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a> and <a href="../../fmt/Fmt_tty/index.html"><code>Fmt_tty</code></a>.</p></div></div></div></body></html>
|
||||
<a href="../Logs/index.html#type-reporter">Logs.reporter</a></span></code></div><div class="spec-doc"><p><code>reporter</code> is like <a href="../Logs/index.html#val-format_reporter"><code>Logs.format_reporter</code></a> except ANSI colors may be used in message header rendering if the formatters are configured to do so; see <a href="../../fmt/Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a> and <code>Fmt_tty</code>.</p><p>Consult a full command line <a href="../Logs_cli/index.html#ex" title="ex">setup example</a>.</p></div></div><h2 id="cheader"><a href="#cheader" class="anchor"></a>Colored message headers</h2><div class="odoc-spec"><div class="spec value anchored" id="val-app_style"><a href="#val-app_style" class="anchor"></a><code><span><span class="keyword">val</span> app_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>app_style</code> is the style used to render headers at app level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err_style"><a href="#val-err_style" class="anchor"></a><code><span><span class="keyword">val</span> err_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>err_style</code> is the style used to render headers at error level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn_style"><a href="#val-warn_style" class="anchor"></a><code><span><span class="keyword">val</span> warn_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>warn_style</code> is the style used to render headers at warning level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_style"><a href="#val-info_style" class="anchor"></a><code><span><span class="keyword">val</span> info_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>info_style</code> is the style used to render headers at info level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug_style"><a href="#val-debug_style" class="anchor"></a><code><span><span class="keyword">val</span> debug_style : <a href="../../fmt/Fmt/index.html#type-style">Fmt.style</a></span></code></div><div class="spec-doc"><p><code>debug_style</code> is the style used to render headers at debug level.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_header"><a href="#val-pp_header" class="anchor"></a><code><span><span class="keyword">val</span> pp_header : <span><span>(<a href="../Logs/index.html#type-level">Logs.level</a> * <span>string option</span>)</span> <a href="../../fmt/Fmt/index.html#type-t">Fmt.t</a></span></span></code></div><div class="spec-doc"><p><code>pp_header</code> is like <a href="../Logs/index.html#val-pp_header"><code>Logs.pp_header</code></a> but may use ANSI colors if the formatter is configured to do so, see <a href="../../fmt/Fmt/index.html#val-set_style_renderer"><code>Fmt.set_style_renderer</code></a> and <code>Fmt_tty</code>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LOG (logs.Logs_lwt.LOG)</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">logs</a> » <a href="../index.html">Logs_lwt</a> » LOG</nav><header class="odoc-preamble"><h1>Module type <code><span>Logs_lwt.LOG</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#logging--value-errors">Logging <code>result</code> value <code>Error</code>s</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-msg"><a href="#val-msg" class="anchor"></a><code><span><span class="keyword">val</span> msg : <span><a href="../../Logs/index.html#type-level">Logs.level</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-msg"><code>Logs.msg</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-app"><a href="#val-app" class="anchor"></a><code><span><span class="keyword">val</span> app : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-app"><code>Logs.app</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err"><a href="#val-err" class="anchor"></a><code><span><span class="keyword">val</span> err : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-err"><code>Logs.err</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn"><a href="#val-warn" class="anchor"></a><code><span><span class="keyword">val</span> warn : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-warn"><code>Logs.warn</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-info"><code>Logs.info</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug"><a href="#val-debug" class="anchor"></a><code><span><span class="keyword">val</span> debug : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-debug"><code>Logs.debug</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kmsg"><a href="#val-kmsg" class="anchor"></a><code><span><span class="keyword">val</span> kmsg :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LOG (logs.Logs_lwt.LOG)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » <a href="../index.html">Logs_lwt</a> » LOG</nav><header class="odoc-preamble"><h1>Module type <code><span>Logs_lwt.LOG</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#logging--value-errors">Logging <code>result</code> value <code>Error</code>s</a></li></ul></nav></div><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-msg"><a href="#val-msg" class="anchor"></a><code><span><span class="keyword">val</span> msg : <span><a href="../../Logs/index.html#type-level">Logs.level</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-msg"><code>Logs.msg</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-app"><a href="#val-app" class="anchor"></a><code><span><span class="keyword">val</span> app : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-app"><code>Logs.app</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-err"><a href="#val-err" class="anchor"></a><code><span><span class="keyword">val</span> err : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-err"><code>Logs.err</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warn"><a href="#val-warn" class="anchor"></a><code><span><span class="keyword">val</span> warn : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-warn"><code>Logs.warn</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-info"><code>Logs.info</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug"><a href="#val-debug" class="anchor"></a><code><span><span class="keyword">val</span> debug : <span><span class="type-var">'a</span> <a href="../index.html#type-log">log</a></span></span></code></div><div class="spec-doc"><p>See <a href="../../Logs/index.html#val-debug"><code>Logs.debug</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-kmsg"><a href="#val-kmsg" class="anchor"></a><code><span><span class="keyword">val</span> kmsg :
|
||||
<span><span class="optlabel">?over</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="../../../lwt/Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../Logs/index.html#type-level">Logs.level</a> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_threaded (logs.Logs_threaded)</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">logs</a> » Logs_threaded</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_threaded</span></code></h1><p>Thread safe logging.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-enable"><a href="#val-enable" class="anchor"></a><code><span><span class="keyword">val</span> enable : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>enable ()</code> enables thread safe logging for OCaml <code>Thread</code>s by installing mutual exclusion primitives via <a href="../Logs/index.html#val-set_reporter_mutex"><code>Logs.set_reporter_mutex</code></a>.</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs_threaded (logs.Logs_threaded)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">logs</a> » Logs_threaded</nav><header class="odoc-preamble"><h1>Module <code><span>Logs_threaded</span></code></h1><p>Thread safe logging.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-enable"><a href="#val-enable" class="anchor"></a><code><span><span class="keyword">val</span> enable : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>enable ()</code> enables thread safe logging for OCaml <code>Thread</code>s by installing mutual exclusion primitives via <a href="../Logs/index.html#val-set_reporter_mutex"><code>Logs.set_reporter_mutex</code></a>.</p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,14 @@
|
|||
v0.8.0 2025-03-10 La Forclaz (VS)
|
||||
---------------------------------
|
||||
|
||||
* Install one library per directory (#48). Thanks to @mefyl
|
||||
for the suggestion.
|
||||
* Requires OCaml >= 4.08, Cmdliner >= 1.3.0, Fmt >= 0.9.0
|
||||
and js_of_ocaml-compiler >= 5.5.0
|
||||
* Depend on the `js_of_ocaml-compiler.runtime` library rather than
|
||||
`js_of_ocaml`.
|
||||
* Handle `cmdliner` deprecations.
|
||||
|
||||
v0.7.0 2019-08-09 Zagreb
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Logs — Logging infrastructure for OCaml
|
||||
-------------------------------------------------------------------------------
|
||||
v0.7.0
|
||||
v0.8.0
|
||||
|
||||
Logs provides a logging infrastructure for OCaml. Logging is performed
|
||||
on sources whose reporting level can be set independently. Log message
|
||||
|
|
@ -40,6 +40,13 @@ instructions.
|
|||
|
||||
The documentation can be consulted [online][doc] or via `odig doc logs`.
|
||||
|
||||
Questions are welcome but better asked on the [OCaml forum][ocaml-forum]
|
||||
than on the issue tracker.
|
||||
|
||||
[doc]: https://erratique.ch/software/logs/doc
|
||||
[ocaml-forum]: https://discuss.ocaml.org/
|
||||
|
||||
|
||||
[doc]: http://erratique.ch/software/logs/doc/
|
||||
|
||||
## Sample programs
|
||||
|
|
|
|||
26
logs/_doc-dir/odoc-pages/index.mld
Normal file
26
logs/_doc-dir/odoc-pages/index.mld
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
{0 Logs {%html: <span class="version">v0.8.0</span>%}}
|
||||
|
||||
Logs provides a logging infrastructure.
|
||||
|
||||
Logging is performed on sources whose reporting level can be set
|
||||
independently. Log message report is decoupled from logging and is
|
||||
handled by a reporter. A few optional log reporters are distributed
|
||||
with the package and the API easily allows to implement your own.
|
||||
|
||||
See the {{!Logs.basics}basics}.
|
||||
|
||||
{1:library_logs Library [logs]}
|
||||
|
||||
{!modules: Logs}
|
||||
|
||||
{1:libraries Libraries [logs.{browser,cli,fmt,lwt,threaded}]}
|
||||
|
||||
Each of these modules lives in its own library.
|
||||
|
||||
{!modules:
|
||||
Logs_browser
|
||||
Logs_cli
|
||||
Logs_fmt
|
||||
Logs_lwt
|
||||
Logs_threaded
|
||||
}
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
(* This code is in the public domain. *)
|
||||
|
||||
(* Example with tags and custom reporter. *)
|
||||
|
||||
let stamp_tag : Mtime.span Logs.Tag.def =
|
||||
Logs.Tag.def "stamp" ~doc:"Relative monotonic time stamp" Mtime.Span.pp
|
||||
|
||||
let stamp c = Logs.Tag.(empty |> add stamp_tag (Mtime_clock.count c))
|
||||
|
||||
let run () =
|
||||
let rec wait n = if n = 0 then () else wait (n - 1) in
|
||||
let c = Mtime_clock.counter () in
|
||||
Logs.info (fun m -> m "Starting run");
|
||||
let delay1, delay2, delay3 = 10_000, 20_000, 40_000 in
|
||||
Logs.info (fun m -> m "Start action 1 (%d)." delay1 ~tags:(stamp c));
|
||||
wait delay1;
|
||||
Logs.info (fun m -> m "Start action 2 (%d)." delay2 ~tags:(stamp c));
|
||||
wait delay2;
|
||||
Logs.info (fun m -> m "Start action 3 (%d)." delay3 ~tags:(stamp c));
|
||||
wait delay3;
|
||||
Logs.info (fun m -> m "Done." ?header:None ~tags:(stamp c));
|
||||
()
|
||||
|
||||
let reporter ppf =
|
||||
let report src level ~over k msgf =
|
||||
let k _ = over (); k () in
|
||||
let with_stamp h tags k ppf fmt =
|
||||
let stamp = match tags with
|
||||
| None -> None
|
||||
| Some tags -> Logs.Tag.find stamp_tag tags
|
||||
in
|
||||
let dt = match stamp with None -> 0. | Some s -> Mtime.Span.to_us s in
|
||||
Format.kfprintf k ppf ("%a[%0+04.0fus] @[" ^^ fmt ^^ "@]@.")
|
||||
Logs.pp_header (level, h) dt
|
||||
in
|
||||
msgf @@ fun ?header ?tags fmt -> with_stamp header tags k ppf fmt
|
||||
in
|
||||
{ Logs.report = report }
|
||||
|
||||
let main () =
|
||||
Logs.set_reporter (reporter (Format.std_formatter));
|
||||
Logs.set_level (Some Logs.Info);
|
||||
run ();
|
||||
run ();
|
||||
()
|
||||
|
||||
let () = main ()
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
(* This code is in the public domain. *)
|
||||
|
||||
(* Example setup for a simple command line tool with colorful output. *)
|
||||
|
||||
let hello _ msg =
|
||||
Logs.app (fun m -> m "%s" msg);
|
||||
Logs.info (fun m -> m "End-user information.");
|
||||
Logs.debug (fun m -> m "Developer information.");
|
||||
Logs.err (fun m -> m "Something bad happened.");
|
||||
Logs.warn (fun m -> m "Something bad may happen in the future.");
|
||||
()
|
||||
|
||||
let setup_log style_renderer level =
|
||||
Fmt_tty.setup_std_outputs ?style_renderer ();
|
||||
Logs.set_level level;
|
||||
Logs.set_reporter (Logs_fmt.reporter ());
|
||||
()
|
||||
|
||||
|
||||
(* Command line interface *)
|
||||
|
||||
open Cmdliner
|
||||
|
||||
let setup_log =
|
||||
let env = Arg.env_var "TOOL_VERBOSITY" in
|
||||
Term.(const setup_log $ Fmt_cli.style_renderer () $ Logs_cli.level ~env ())
|
||||
|
||||
let msg =
|
||||
let doc = "The message to output." in
|
||||
Arg.(value & pos 0 string "Hello horrible world!" & info [] ~doc)
|
||||
|
||||
let main () =
|
||||
match Term.(eval (const hello $ setup_log $ msg, Term.info "tool")) with
|
||||
| `Error _ -> exit 1
|
||||
| _ -> exit (if Logs.err_count () > 0 then 1 else 0)
|
||||
|
||||
let () = main ()
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (logs.index)</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> – logs</nav><header class="odoc-preamble"><h1 id="package-logs"><a href="#package-logs" class="anchor"></a>Package logs <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Logs/index.html"><code>Logs</code></a> <span class="synopsis">Logging.</span></li><li><a href="Logs_cli/index.html"><code>Logs_cli</code></a> <span class="synopsis"><a href="../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <a href="Logs/index.html"><code>Logs</code></a>.</span></li><li><a href="Logs_fmt/index.html"><code>Logs_fmt</code></a> <span class="synopsis"><code>Format</code> colorful reporter for <a href="Logs/index.html"><code>Logs</code></a>.</span></li><li><a href="Logs_lwt/index.html"><code>Logs_lwt</code></a> <span class="synopsis"><a href="../lwt/Lwt/index.html"><code>Lwt</code></a> logging.</span></li><li><a href="Logs_threaded/index.html"><code>Logs_threaded</code></a> <span class="synopsis">Thread safe logging.</span></li></ul></header><nav class="odoc-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (logs.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » logs</nav><header class="odoc-preamble"><h1 id="package-logs"><a href="#package-logs" class="anchor"></a>Package logs <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p>Logs provides a logging infrastructure.</p><p>Logging is performed on sources whose reporting level can be set independently. Log message report is decoupled from logging and is handled by a reporter. A few optional log reporters are distributed with the package and the API easily allows to implement your own.</p><p>See the <a href="Logs/index.html#basics" title="basics">basics</a>.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#library_logs">Library <code>logs</code></a></li><li><a href="#libraries">Libraries <code>logs.{browser,cli,fmt,lwt,threaded}</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="library_logs"><a href="#library_logs" class="anchor"></a>Library <code>logs</code></h2><ul class="modules"><li><a href="Logs/index.html"><code>Logs</code></a> <span class="synopsis">Logging.</span></li></ul><h2 id="libraries"><a href="#libraries" class="anchor"></a>Libraries <code>logs.{browser,cli,fmt,lwt,threaded}</code></h2><p>Each of these modules lives in its own library.</p><ul class="modules"><li><code>Logs_browser</code> </li><li><a href="Logs_cli/index.html"><code>Logs_cli</code></a> <span class="synopsis"><a href="../cmdliner/Cmdliner/index.html"><code>Cmdliner</code></a> support for <a href="Logs/index.html"><code>Logs</code></a>.</span></li><li><a href="Logs_fmt/index.html"><code>Logs_fmt</code></a> <span class="synopsis"><code>Format</code> colorful reporter for <a href="Logs/index.html"><code>Logs</code></a>.</span></li><li><a href="Logs_lwt/index.html"><code>Logs_lwt</code></a> <span class="synopsis"><a href="../lwt/Lwt/index.html"><code>Lwt</code></a> logging.</span></li><li><a href="Logs_threaded/index.html"><code>Logs_threaded</code></a> <span class="synopsis">Thread safe logging.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!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> » <a href="../../index.html">Lsp</a> » <a href="../index.html">Cli</a> » 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">-></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">-></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">-></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">-></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>
|
||||
<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 3.0.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">lsp</a> » <a href="../../index.html">Lsp</a> » <a href="../index.html">Cli</a> » 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">-></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">-></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">-></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">-></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>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Channel (lsp.Lsp.Cli.Channel)</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> » <a href="../../index.html">Lsp</a> » <a href="../index.html">Cli</a> » Channel</nav><header class="odoc-preamble"><h1>Module <code><span>Cli.Channel</span></code></h1><p>The channel the server shold use to listen for connections</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><span> = </span></code><ol><li id="type-t.Stdio" class="def variant constructor anchored"><a href="#type-t.Stdio" class="anchor"></a><code><span>| </span><span><span class="constructor">Stdio</span></span></code></li><li id="type-t.Pipe" class="def variant constructor anchored"><a href="#type-t.Pipe" class="anchor"></a><code><span>| </span><span><span class="constructor">Pipe</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A path to the unix domain socket or windows pipe</p><span class="comment-delim">*)</span></div></li><li id="type-t.Socket" class="def variant constructor anchored"><a href="#type-t.Socket" class="anchor"></a><code><span>| </span><span><span class="constructor">Socket</span> <span class="keyword">of</span> int</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A tcp connection on localhost with the port number</p><span class="comment-delim">*)</span></div></li></ol></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Channel (lsp.Lsp.Cli.Channel)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">lsp</a> » <a href="../../index.html">Lsp</a> » <a href="../index.html">Cli</a> » Channel</nav><header class="odoc-preamble"><h1>Module <code><span>Cli.Channel</span></code></h1><p>The channel the server shold use to listen for connections</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><span> = </span></code><ol><li id="type-t.Stdio" class="def variant constructor anchored"><a href="#type-t.Stdio" class="anchor"></a><code><span>| </span><span><span class="constructor">Stdio</span></span></code></li><li id="type-t.Pipe" class="def variant constructor anchored"><a href="#type-t.Pipe" class="anchor"></a><code><span>| </span><span><span class="constructor">Pipe</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A path to the unix domain socket or windows pipe</p><span class="comment-delim">*)</span></div></li><li id="type-t.Socket" class="def variant constructor anchored"><a href="#type-t.Socket" class="anchor"></a><code><span>| </span><span><span class="constructor">Socket</span> <span class="keyword">of</span> int</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A tcp connection on localhost with the port number</p><span class="comment-delim">*)</span></div></li></ol></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cli (lsp.Lsp.Cli)</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> » <a href="../index.html">Lsp</a> » Cli</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Cli</span></code></h1><p>Handling of standard lsp server command line arguments</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Channel"><a href="#module-Channel" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Channel/index.html">Channel</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The channel the server shold use to listen for connections</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Arg/index.html">Arg</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Parsing of the standard commnad line arguments using <code>Stdlib.Arg</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-args"><a href="#val-args" class="anchor"></a><code><span><span class="keyword">val</span> args : <span><span class="optlabel">?channel</span>:<a href="Channel/index.html#type-t">Channel.t</a> <span class="arrow">-></span></span> <span><span class="optlabel">?clientProcessId</span>:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <span>string list</span></span></code></div><div class="spec-doc"><p>generate command line arguments that can be used to spawn an lsp client</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cli (lsp.Lsp.Cli)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">lsp</a> » <a href="../index.html">Lsp</a> » Cli</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Cli</span></code></h1><p>Handling of standard lsp server command line arguments</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Channel"><a href="#module-Channel" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Channel/index.html">Channel</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The channel the server shold use to listen for connections</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Arg"><a href="#module-Arg" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Arg/index.html">Arg</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Parsing of the standard commnad line arguments using <code>Stdlib.Arg</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-args"><a href="#val-args" class="anchor"></a><code><span><span class="keyword">val</span> args : <span><span class="optlabel">?channel</span>:<a href="Channel/index.html#type-t">Channel.t</a> <span class="arrow">-></span></span> <span><span class="optlabel">?clientProcessId</span>:int <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <span>string list</span></span></code></div><div class="spec-doc"><p>generate command line arguments that can be used to spawn an lsp client</p></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Client_request (lsp.Lsp.Client_request)</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> » <a href="../index.html">Lsp</a> » Client_request</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Client_request</span></code></h1></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> <span>_ t</span></span><span> = </span></code><ol><li id="type-t.Shutdown" class="def variant constructor anchored"><a href="#type-t.Shutdown" class="anchor"></a><code><span>| </span><span><span class="constructor">Shutdown</span> : <span>unit <a href="#type-t">t</a></span></span></code></li><li id="type-t.Initialize" class="def variant constructor anchored"><a href="#type-t.Initialize" class="anchor"></a><code><span>| </span><span><span class="constructor">Initialize</span> : <a href="../Types/InitializeParams/index.html#type-t">Types.InitializeParams.t</a> <span class="arrow">-></span> <span><a href="../Types/InitializeResult/index.html#type-t">Types.InitializeResult.t</a> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentHover" class="def variant constructor anchored"><a href="#type-t.TextDocumentHover" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentHover</span> : <a href="../Types/HoverParams/index.html#type-t">Types.HoverParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Hover/index.html#type-t">Types.Hover.t</a> option</span> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentDefinition" class="def variant constructor anchored"><a href="#type-t.TextDocumentDefinition" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentDefinition</span> : <a href="../Types/DefinitionParams/index.html#type-t">Types.DefinitionParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Locations/index.html#type-t">Types.Locations.t</a> option</span> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentDeclaration" class="def variant constructor anchored"><a href="#type-t.TextDocumentDeclaration" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentDeclaration</span> : <a href="../Types/TextDocumentPositionParams/index.html#type-t">Types.TextDocumentPositionParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Locations/index.html#type-t">Types.Locations.t</a>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Client_request (lsp.Lsp.Client_request)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">lsp</a> » <a href="../index.html">Lsp</a> » Client_request</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Client_request</span></code></h1></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> <span>_ t</span></span><span> = </span></code><ol><li id="type-t.Shutdown" class="def variant constructor anchored"><a href="#type-t.Shutdown" class="anchor"></a><code><span>| </span><span><span class="constructor">Shutdown</span> : <span>unit <a href="#type-t">t</a></span></span></code></li><li id="type-t.Initialize" class="def variant constructor anchored"><a href="#type-t.Initialize" class="anchor"></a><code><span>| </span><span><span class="constructor">Initialize</span> : <a href="../Types/InitializeParams/index.html#type-t">Types.InitializeParams.t</a> <span class="arrow">-></span> <span><a href="../Types/InitializeResult/index.html#type-t">Types.InitializeResult.t</a> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentHover" class="def variant constructor anchored"><a href="#type-t.TextDocumentHover" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentHover</span> : <a href="../Types/HoverParams/index.html#type-t">Types.HoverParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Hover/index.html#type-t">Types.Hover.t</a> option</span> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentDefinition" class="def variant constructor anchored"><a href="#type-t.TextDocumentDefinition" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentDefinition</span> : <a href="../Types/DefinitionParams/index.html#type-t">Types.DefinitionParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Locations/index.html#type-t">Types.Locations.t</a> option</span> <a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentDeclaration" class="def variant constructor anchored"><a href="#type-t.TextDocumentDeclaration" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentDeclaration</span> : <a href="../Types/TextDocumentPositionParams/index.html#type-t">Types.TextDocumentPositionParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Locations/index.html#type-t">Types.Locations.t</a>
|
||||
option</span>
|
||||
<a href="#type-t">t</a></span></span></code></li><li id="type-t.TextDocumentTypeDefinition" class="def variant constructor anchored"><a href="#type-t.TextDocumentTypeDefinition" class="anchor"></a><code><span>| </span><span><span class="constructor">TextDocumentTypeDefinition</span> : <a href="../Types/TypeDefinitionParams/index.html#type-t">Types.TypeDefinitionParams.t</a> <span class="arrow">-></span> <span><span><a href="../Types/Locations/index.html#type-t">Types.Locations.t</a>
|
||||
option</span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diff (lsp.Lsp.Diff)</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> » <a href="../index.html">Lsp</a> » Diff</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Diff</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-edit"><a href="#val-edit" class="anchor"></a><code><span><span class="keyword">val</span> edit : <span><span class="label">from</span>:string <span class="arrow">-></span></span> <span><span class="label">to_</span>:string <span class="arrow">-></span></span> <span><a href="../Types/TextEdit/index.html#type-t">Types.TextEdit.t</a> list</span></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diff (lsp.Lsp.Diff)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">lsp</a> » <a href="../index.html">Lsp</a> » Diff</nav><header class="odoc-preamble"><h1>Module <code><span>Lsp.Diff</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-edit"><a href="#val-edit" class="anchor"></a><code><span><span class="keyword">val</span> edit : <span><span class="label">from</span>:string <span class="arrow">-></span></span> <span><span class="label">to_</span>:string <span class="arrow">-></span></span> <span><a href="../Types/TextEdit/index.html#type-t">Types.TextEdit.t</a> list</span></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Params (lsp.Lsp.Extension.DebugEcho.Params)</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> » <a href="../../../index.html">Lsp</a> » <a href="../../index.html">Extension</a> » <a href="../index.html">DebugEcho</a> » Params</nav><header class="odoc-preamble"><h1>Module <code><span>DebugEcho.Params</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../../../ppx_yojson_conv_lib/Ppx_yojson_conv_lib/Yojsonable/module-type-S/index.html">Ppx_yojson_conv_lib.Yojsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../../../ppx_yojson_conv_lib/Ppx_yojson_conv_lib/Yojsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../../../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a> <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a></span></code></div></div></details></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Params (lsp.Lsp.Extension.DebugEcho.Params)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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">lsp</a> » <a href="../../../index.html">Lsp</a> » <a href="../../index.html">Extension</a> » <a href="../index.html">DebugEcho</a> » Params</nav><header class="odoc-preamble"><h1>Module <code><span>DebugEcho.Params</span></code></h1></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><span> = </span><span>{</span></code><ol><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../../../ppx_yojson_conv_lib/Ppx_yojson_conv_lib/Yojsonable/module-type-S/index.html">Ppx_yojson_conv_lib.Yojsonable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../../../ppx_yojson_conv_lib/Ppx_yojson_conv_lib/Yojsonable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-t_of_yojson"><a href="#val-t_of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> t_of_yojson : <span><a href="../../../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a> <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-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span><span class="keyword">val</span> yojson_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../../../yojson/Yojson/Safe/index.html#type-t">Yojson.Safe.t</a></span></code></div></div></details></div></div></body></html>
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue