-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
349 changed files
with
5,843 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pool (caqti-async.Caqti_async.Pool)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">caqti-async</a> » <a href="../index.html">Caqti_async</a> » Pool</nav><header class="odoc-preamble"><h1>Module <code><span>Caqti_async.Pool</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>('a, +'e) t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-size"><a href="#val-size" class="anchor"></a><code><span><span class="keyword">val</span> size : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>size pool</code> is the current number of open resources in <code>pool</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-use"><a href="#val-use" class="anchor"></a><code><span><span class="keyword">val</span> use : | ||
| <span><span class="optlabel">?priority</span>:float <span class="arrow">-></span></span> | ||
| <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span>)</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>use f pool</code> calls <code>f</code> on a resource drawn from <code>pool</code>, handing back the resource to the pool when <code>f</code> exits.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">priority</span> <p>Requests for the resource are handled in decreasing order of priority. The default priority is <code>0.0</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drain"><a href="#val-drain" class="anchor"></a><code><span><span class="keyword">val</span> drain : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span>unit <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>drain pool</code> closes all resources in <code>pool</code>. The pool is still usable, as new resources will be created on demand.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Stream (caqti-async.Caqti_async.Stream)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">caqti-async</a> » <a href="../index.html">Caqti_async</a> » Stream</nav><header class="odoc-preamble"><h1>Module <code><span>Caqti_async.Stream</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>('a, 'err) t</span></span><span> = <span>unit <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-node">node</a></span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p>A stream, represented as a lazy chain of <a href="#type-node.Cons"><code>Cons</code></a>-nodes terminating in a <a href="#type-node.Nil"><code>Nil</code></a> or an <a href="#type-node.Error"><code>Error</code></a>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-node"><a href="#type-node" class="anchor"></a><code><span><span class="keyword">and</span> <span>('a, 'err) node</span></span><span> = </span></code><ol><li id="type-node.Nil" class="def variant constructor anchored"><a href="#type-node.Nil" class="anchor"></a><code><span>| </span><span><span class="constructor">Nil</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The node of an empty stream</p><span class="comment-delim">*)</span></div></li><li id="type-node.Error" class="def variant constructor anchored"><a href="#type-node.Error" class="anchor"></a><code><span>| </span><span><span class="constructor">Error</span> <span class="keyword">of</span> <span class="type-var">'err</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A node of a permanently failed stream.</p><span class="comment-delim">*)</span></div></li><li id="type-node.Cons" class="def variant constructor anchored"><a href="#type-node.Cons" class="anchor"></a><code><span>| </span><span><span class="constructor">Cons</span> <span class="keyword">of</span> <span class="type-var">'a</span> * <span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A node holding the next element and continuation of a stream.</p><span class="comment-delim">*)</span></div></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span><span class="keyword">val</span> fold : | ||
| <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'state</span> <span class="arrow">-></span></span> <span class="type-var">'state</span>)</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="type-var">'state</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'state</span>, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>fold ~f stream acc</code> consumes the remainder elements <code>e1</code>, ..., <code>eN</code> of <code>stream</code> and returns <code>Ok (acc |> f e1 |> ... |> f eN)</code> if no error occurred</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fold_s"><a href="#val-fold_s" class="anchor"></a><code><span><span class="keyword">val</span> fold_s : | ||
| <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'state</span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'state</span>, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span>)</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'clog</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="type-var">'state</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'state</span>, <span>[> <span>`Congested of <span class="type-var">'clog</span></span> ]</span> <span class="keyword">as</span> 'err)</span> <span class="xref-unresolved">Stdlib</span>.result</span> | ||
| <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>fold_s ~f stream acc</code> consumes the remainder of <code>stream</code>, passing each element in order to <code>f</code> along with the latest accumulation starting at <code>acc</code>, and returning the final accumulation if successful. An error result may be due to either the stream provider or the callback, as distinguished with the <code>`Congested</code> constructor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iter_s"><a href="#val-iter_s" class="anchor"></a><code><span><span class="keyword">val</span> iter_s : | ||
| <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span><span>(unit, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span>)</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'clog</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span><span>(unit, <span>[> <span>`Congested of <span class="type-var">'clog</span></span> ]</span> <span class="keyword">as</span> 'err)</span> <span class="xref-unresolved">Stdlib</span>.result</span> | ||
| <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>iter_s ~f stream</code> consumes the remainder of <code>stream</code>, passing each element in order to <code>f</code>. An error result may be due to either the steram provider or the callback, as distinguished with the <code>`Congested</code> constructor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_rev_list"><a href="#val-to_rev_list" class="anchor"></a><code><span><span class="keyword">val</span> to_rev_list : | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span><span class="type-var">'a</span> list</span>, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>to_rev_list stream</code> consumes the remainder of <code>stream</code>, returning a list of its element in reverse order of production.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span><span class="keyword">val</span> to_list : | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span><span class="type-var">'a</span> list</span>, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div><div class="spec-doc"><p><code>to_list stream</code> consumes the remainder of <code>stream</code>, returning a list of its element in order of production.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_list"><a href="#val-of_list" class="anchor"></a><code><span><span class="keyword">val</span> of_list : <span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>of_list xs</code> is a non-failing finite stream (re)producing the elements <code>xs</code> in order of occurrence.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map_result"><a href="#val-map_result" class="anchor"></a><code><span><span class="keyword">val</span> map_result : | ||
| <span><span class="label">f</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'err</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span>)</span> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> | ||
| <span><span>(<span class="type-var">'b</span>, <span class="type-var">'err</span>)</span> <a href="#type-t">t</a></span></span></code></div></div></div></body></html> |
Oops, something went wrong.