Skip to content

Commit

Permalink
Update middleware doc to 0.0.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
@sktrent
sktrent committed Jan 23, 2024
1 parent 109f8d9 commit ab2b312
Show file tree
Hide file tree
Showing 30 changed files with 1,001 additions and 163 deletions.
4 changes: 2 additions & 2 deletions middleware/Middleware/Diverter/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diverter (middleware.Middleware.Diverter)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">middleware</a> &#x00BB; <a href="../index.html">Middleware</a> &#x00BB; Diverter</nav><header class="odoc-preamble"><h1>Module <code><span>Middleware.Diverter</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>(!'next_input, !'next_output, !'output) t</span></span><span> =
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diverter (middleware.Middleware.Diverter)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">middleware</a> &#x00BB; <a href="../index.html">Middleware</a> &#x00BB; Diverter</nav><header class="odoc-preamble"><h1>Module <code><span>Middleware.Diverter</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>(!'next_input, !'next_output, !'output) t</span></span><span> =
<span><span>(<span class="type-var">'next_input</span>, <span class="type-var">'next_output</span>, <span class="type-var">'output</span>)</span> <a href="../Make/Diverter/index.html#type-t">Make(Monads.Identity).Diverter.t</a></span></span><span> =
</span></code><ol><li id="type-t.Stop" class="def variant constructor anchored"><a href="#type-t.Stop" class="anchor"></a><code><span>| </span><span><span class="constructor">Stop</span> <span class="keyword">of</span> <span><span class="type-var">'output0</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control stops here, and the <code>'output</code> is returned to the wrapping <code>Middleware</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Continue" class="def variant constructor anchored"><a href="#type-t.Continue" class="anchor"></a><code><span>| </span><span><span class="constructor">Continue</span> <span class="keyword">of</span> <span class="type-var">'next_input0</span> * <span>(<span><span class="type-var">'next_output0</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'output1</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span>)</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control continues to the next <code>Middleware</code> <code>g</code>, which receives <code>'next_input</code> as input. After <code>g</code> runs, its result is transformed with the given function.</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Union, determining whether or not to run a subsequent <code>Middleware</code> or return early.</p></div></div></div></body></html>
</span></code><ol><li id="type-t.Stop" class="def variant constructor anchored"><a href="#type-t.Stop" class="anchor"></a><code><span>| </span><span><span class="constructor">Stop</span> <span class="keyword">of</span> <span><span class="type-var">'output0</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control stops here, and the <code>'output</code> is returned to the wrapping <code>Middleware</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Continue" class="def variant constructor anchored"><a href="#type-t.Continue" class="anchor"></a><code><span>| </span><span><span class="constructor">Continue</span> <span class="keyword">of</span> <span class="type-var">'next_input0</span> * <span>(<span><span class="type-var">'next_output0</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'output1</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span>)</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control continues to the next <code>Middleware</code> <code>g</code>, which receives <code>'next_input</code> as input. After <code>g</code> runs, its result is transformed with the given function.</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Union, determining whether or not to run a subsequent <code>Middleware</code> or return early.</p></div></div></div></body></html>
4 changes: 2 additions & 2 deletions middleware/Middleware/Infix/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (middleware.Middleware.Infix)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">middleware</a> &#x00BB; <a href="../index.html">Middleware</a> &#x00BB; Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Middleware.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&lt;&gt;&gt;)"><a href="#val-(&lt;&lt;&gt;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&lt;&gt;&gt;) :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (middleware.Middleware.Infix)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">middleware</a> &#x00BB; <a href="../index.html">Middleware</a> &#x00BB; Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Middleware.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&lt;&gt;&gt;)"><a href="#val-(&lt;&lt;&gt;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&lt;&gt;&gt;) :
<span><span><span>(<span class="type-var">'ai</span>, <span class="type-var">'bi</span>, <span class="type-var">'bo</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'bi</span>, <span class="type-var">'ci</span>, <span class="type-var">'co</span>, <span class="type-var">'bo</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="type-var">'ai</span>, <span class="type-var">'ci</span>, <span class="type-var">'co</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&lt;&gt;&gt; mb</code> is an infix <code>compose</code> operator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&amp;&gt;)"><a href="#val-(&lt;&amp;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&amp;&gt;) :
<span><span><span>(<span class="type-var">'ai</span>, <span class="type-var">'bi</span>, <span class="type-var">'bo</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span class="type-var">'bi</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'bo</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'ai</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'ao</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&amp;&gt; mb</code> is an infix <code>terminate</code> operator.</p></div></div></div></body></html>
<span><span class="type-var">'ao</span> <a href="../Monads/Identity/index.html#type-t">Monads.Identity.t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&amp;&gt; mb</code> is an infix <code>terminate</code> operator.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion middleware/Middleware/Make/Diverter/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diverter (middleware.Middleware.Make.Diverter)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">middleware</a> &#x00BB; <a href="../../index.html">Middleware</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Diverter</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Diverter</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>('next_input, 'next_output, 'output) t</span></span><span> = </span></code><ol><li id="type-t.Stop" class="def variant constructor anchored"><a href="#type-t.Stop" class="anchor"></a><code><span>| </span><span><span class="constructor">Stop</span> <span class="keyword">of</span> <span><span class="type-var">'output</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control stops here, and the <code>'output</code> is returned to the wrapping <code>Middleware</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Continue" class="def variant constructor anchored"><a href="#type-t.Continue" class="anchor"></a><code><span>| </span><span><span class="constructor">Continue</span> <span class="keyword">of</span> <span class="type-var">'next_input</span> * <span>(<span><span class="type-var">'next_output</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'output</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span>)</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control continues to the next <code>Middleware</code> <code>g</code>, which receives <code>'next_input</code> as input. After <code>g</code> runs, its result is transformed with the given function.</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Union, determining whether or not to run a subsequent <code>Middleware</code> or return early.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diverter (middleware.Middleware.Make.Diverter)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">middleware</a> &#x00BB; <a href="../../index.html">Middleware</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Diverter</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Diverter</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>('next_input, 'next_output, 'output) t</span></span><span> = </span></code><ol><li id="type-t.Stop" class="def variant constructor anchored"><a href="#type-t.Stop" class="anchor"></a><code><span>| </span><span><span class="constructor">Stop</span> <span class="keyword">of</span> <span><span class="type-var">'output</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control stops here, and the <code>'output</code> is returned to the wrapping <code>Middleware</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Continue" class="def variant constructor anchored"><a href="#type-t.Continue" class="anchor"></a><code><span>| </span><span><span class="constructor">Continue</span> <span class="keyword">of</span> <span class="type-var">'next_input</span> * <span>(<span><span class="type-var">'next_output</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'output</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span>)</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Control continues to the next <code>Middleware</code> <code>g</code>, which receives <code>'next_input</code> as input. After <code>g</code> runs, its result is transformed with the given function.</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Union, determining whether or not to run a subsequent <code>Middleware</code> or return early.</p></div></div></div></body></html>
4 changes: 2 additions & 2 deletions middleware/Middleware/Make/Infix/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (middleware.Middleware.Make.Infix)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">middleware</a> &#x00BB; <a href="../../index.html">Middleware</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&lt;&gt;&gt;)"><a href="#val-(&lt;&lt;&gt;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&lt;&gt;&gt;) :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (middleware.Middleware.Make.Infix)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">middleware</a> &#x00BB; <a href="../../index.html">Middleware</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Infix</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Infix</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&lt;&gt;&gt;)"><a href="#val-(&lt;&lt;&gt;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&lt;&gt;&gt;) :
<span><span><span>(<span class="type-var">'ai</span>, <span class="type-var">'bi</span>, <span class="type-var">'bo</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'bi</span>, <span class="type-var">'ci</span>, <span class="type-var">'co</span>, <span class="type-var">'bo</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="type-var">'ai</span>, <span class="type-var">'ci</span>, <span class="type-var">'co</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&lt;&gt;&gt; mb</code> is an infix <code>compose</code> operator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&amp;&gt;)"><a href="#val-(&lt;&amp;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&amp;&gt;) : <span><span><span>(<span class="type-var">'ai</span>, <span class="type-var">'bi</span>, <span class="type-var">'bo</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'bi</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'bo</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'ai</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'ao</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&amp;&gt; mb</code> is an infix <code>terminate</code> operator.</p></div></div></div></body></html>
<span><span>(<span class="type-var">'ai</span>, <span class="type-var">'ci</span>, <span class="type-var">'co</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&lt;&gt;&gt; mb</code> is an infix <code>compose</code> operator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&lt;&amp;&gt;)"><a href="#val-(&lt;&amp;&gt;)" class="anchor"></a><code><span><span class="keyword">val</span> (&lt;&amp;&gt;) : <span><span><span>(<span class="type-var">'ai</span>, <span class="type-var">'bi</span>, <span class="type-var">'bo</span>, <span class="type-var">'ao</span>)</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'bi</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'bo</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'ai</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'ao</span> <a href="../argument-1-M/index.html#type-t">M.t</a></span></span></code></div><div class="spec-doc"><p><code>ma &lt;&amp;&gt; mb</code> is an infix <code>terminate</code> operator.</p></div></div></div></body></html>
Loading

0 comments on commit ab2b312

Please sign in to comment.