Skip to content

Commit

Permalink
Update cohttp doc to 6.0.0~alpha2.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mseri
mseri committed Aug 8, 2023
1 parent c4e0af9 commit 2a26974
Show file tree
Hide file tree
Showing 225 changed files with 217 additions and 214 deletions.
2 changes: 1 addition & 1 deletion cohttp-async/Cohttp_async/Body/Private/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>Private (cohttp-async.Cohttp_async.Body.Private)</title><link rel="stylesheet" href="../../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../../index.html">Cohttp_async</a> &#x00BB; <a href="../index.html">Body</a> &#x00BB; Private</nav><header class="odoc-preamble"><h1>Module <code><span>Body.Private</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-write_body"><a href="#val-write_body" class="anchor"></a><code><span><span class="keyword">val</span> write_body :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Private (cohttp-async.Cohttp_async.Body.Private)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../../index.html">Cohttp_async</a> &#x00BB; <a href="../index.html">Body</a> &#x00BB; Private</nav><header class="odoc-preamble"><h1>Module <code><span>Body.Private</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-write_body"><a href="#val-write_body" class="anchor"></a><code><span><span class="keyword">val</span> write_body :
<span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.string <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.unit <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion cohttp-async/Cohttp_async/Body/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>Body (cohttp-async.Cohttp_async.Body)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../index.html">Cohttp_async</a> &#x00BB; Body</nav><header class="odoc-preamble"><h1>Module <code><span>Cohttp_async.Body</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.Cohttp.Body.t" class="def type anchored"><a href="#type-t.Cohttp.Body.t" class="anchor"></a><code><span>| </span></code><code><span><a href="../../../cohttp/Cohttp/Body/index.html#type-t">Cohttp.Body.t</a></span></code></li><li id="type-t.Pipe" class="def constructor anchored"><a href="#type-t.Pipe" class="anchor"></a><code><span>| </span></code><code><span>`Pipe <span class="keyword">of</span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_t"><a href="#val-sexp_of_t" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_t : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Sexplib0</span>.Sexp.t</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../cohttp/Cohttp/S/module-type-Body/index.html">Cohttp.S.Body</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../cohttp/Cohttp/S/module-type-Body/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-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_list"><a href="#val-of_string_list" class="anchor"></a><code><span><span class="keyword">val</span> of_string_list : <span><span>string list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_form"><a href="#val-of_form" class="anchor"></a><code><span><span class="keyword">val</span> of_form : <span>?scheme:string <span class="arrow">&#45;&gt;</span></span> <span><span><span>(string * <span>string list</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-transfer_encoding"><a href="#val-transfer_encoding" class="anchor"></a><code><span><span class="keyword">val</span> transfer_encoding : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../cohttp/Cohttp/Transfer/index.html#type-encoding">Cohttp.Transfer.encoding</a></span></code></div></div></details></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><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.unit <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.bool <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></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">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string_list"><a href="#val-to_string_list" class="anchor"></a><code><span><span class="keyword">val</span> to_string_list : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Base</span>.list</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_pipe"><a href="#val-to_pipe" class="anchor"></a><code><span><span class="keyword">val</span> to_pipe : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_pipe"><a href="#val-of_pipe" class="anchor"></a><code><span><span class="keyword">val</span> of_pipe : <span><span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>f:<span>(<span><span class="xref-unresolved">Base</span>.string <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Base</span>.string)</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-as_pipe"><a href="#val-as_pipe" class="anchor"></a><code><span><span class="keyword">val</span> as_pipe :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Body (cohttp-async.Cohttp_async.Body)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../index.html">Cohttp_async</a> &#x00BB; Body</nav><header class="odoc-preamble"><h1>Module <code><span>Cohttp_async.Body</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.Cohttp.Body.t" class="def type anchored"><a href="#type-t.Cohttp.Body.t" class="anchor"></a><code><span>| </span></code><code><span><a href="../../../cohttp/Cohttp/Body/index.html#type-t">Cohttp.Body.t</a></span></code></li><li id="type-t.Pipe" class="def constructor anchored"><a href="#type-t.Pipe" class="anchor"></a><code><span>| </span></code><code><span>`Pipe <span class="keyword">of</span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_t"><a href="#val-sexp_of_t" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_t : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Sexplib0</span>.Sexp.t</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../cohttp/Cohttp/S/module-type-Body/index.html">Cohttp.S.Body</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../cohttp/Cohttp/S/module-type-Body/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-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_list"><a href="#val-of_string_list" class="anchor"></a><code><span><span class="keyword">val</span> of_string_list : <span><span>string list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_form"><a href="#val-of_form" class="anchor"></a><code><span><span class="keyword">val</span> of_form : <span>?scheme:string <span class="arrow">&#45;&gt;</span></span> <span><span><span>(string * <span>string list</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-transfer_encoding"><a href="#val-transfer_encoding" class="anchor"></a><code><span><span class="keyword">val</span> transfer_encoding : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../cohttp/Cohttp/Transfer/index.html#type-encoding">Cohttp.Transfer.encoding</a></span></code></div></div></details></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><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.unit <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.bool <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></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">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string_list"><a href="#val-to_string_list" class="anchor"></a><code><span><span class="keyword">val</span> to_string_list : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Base</span>.list</span> <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_pipe"><a href="#val-to_pipe" class="anchor"></a><code><span><span class="keyword">val</span> to_pipe : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_pipe"><a href="#val-of_pipe" class="anchor"></a><code><span><span class="keyword">val</span> of_pipe : <span><span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>f:<span>(<span><span class="xref-unresolved">Base</span>.string <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Base</span>.string)</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-as_pipe"><a href="#val-as_pipe" class="anchor"></a><code><span><span class="keyword">val</span> as_pipe :
<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>f:
<span>(<span><span><span class="xref-unresolved">Base</span>.string <span class="xref-unresolved">Async_kernel</span>.Pipe.Reader.t</span> <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion cohttp-async/Cohttp_async/Client/Connection/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>Connection (cohttp-async.Cohttp_async.Client.Connection)</title><link rel="stylesheet" href="../../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../../index.html">Cohttp_async</a> &#x00BB; <a href="../index.html">Client</a> &#x00BB; Connection</nav><header class="odoc-preamble"><h1>Module <code><span>Client.Connection</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-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Connection (cohttp-async.Cohttp_async.Client.Connection)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">cohttp-async</a> &#x00BB; <a href="../../index.html">Cohttp_async</a> &#x00BB; <a href="../index.html">Client</a> &#x00BB; Connection</nav><header class="odoc-preamble"><h1>Module <code><span>Client.Connection</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-connect"><a href="#val-connect" class="anchor"></a><code><span><span class="keyword">val</span> connect :
<span>?interrupt:<span>unit <span class="xref-unresolved">Async_kernel</span>.Deferred.t</span> <span class="arrow">&#45;&gt;</span></span>
<span>?ssl_config:<span class="xref-unresolved">Conduit_async</span>.V2.Ssl.Config.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Uri</span>.t <span class="arrow">&#45;&gt;</span></span>
Expand Down
Loading

0 comments on commit 2a26974

Please sign in to comment.