This commit is contained in:
c-cube 2023-01-25 18:49:31 +00:00
parent 5f3c4e5f6e
commit ecd89e727c
37 changed files with 659 additions and 82 deletions

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl-lwt.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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> ezcurl-lwt</nav><header class="odoc-preamble"><h1 id="ezcurl-lwt-index"><a href="#ezcurl-lwt-index" class="anchor"></a>ezcurl-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl-lwt">Library ezcurl-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl-lwt"><a href="#library-ezcurl-lwt" class="anchor"></a>Library ezcurl-lwt</h2><p>The entry point of this library is the module: <a href="Ezcurl_lwt/index.html"><code>Ezcurl_lwt</code></a>.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl-lwt.index)</title><link rel="stylesheet" href="../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="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl-lwt</nav><header class="odoc-preamble"><h1 id="ezcurl-lwt-index"><a href="#ezcurl-lwt-index" class="anchor"></a>ezcurl-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl-lwt">Library ezcurl-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl-lwt"><a href="#library-ezcurl-lwt" class="anchor"></a>Library ezcurl-lwt</h2><p>The entry point of this library is the module: <a href="Ezcurl_lwt/index.html"><code>Ezcurl_lwt</code></a>.</p></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (ezcurl.Ezcurl_core.Config)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><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" id="val-default" class="anchored"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-verbose" class="anchored"><a href="#val-verbose" class="anchor"></a><code><span><span class="keyword">val</span> verbose : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-authmethod" class="anchored"><a href="#val-authmethod" class="anchor"></a><code><span><span class="keyword">val</span> authmethod : <span><span><span class="xref-unresolved">Curl</span>.curlAuth list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-max_redirects" class="anchored"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-follow_location" class="anchored"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-username" class="anchored"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-password" class="anchored"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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" id="val-pp" class="anchored"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_string" class="anchored"><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> string</span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (ezcurl.Ezcurl_core.Config)</title><link rel="stylesheet" href="../../../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="../../../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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</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-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span><span class="keyword">val</span> verbose : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-authmethod"><a href="#val-authmethod" class="anchor"></a><code><span><span class="keyword">val</span> authmethod : <span><span><span class="xref-unresolved">Curl</span>.curlAuth list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-username"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-password"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <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-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</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> string</span></code></div></div></div></body></html>

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.Make.1-IO)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">ezcurl</a> &#x00BB; <a href="../../index.html">Ezcurl_core</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; 1-IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.1-IO</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-return" class="anchored"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(&gt;&gt;=)" class="anchored"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(&gt;|=)" class="anchored"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-fail" class="anchored"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-perform" class="anchored"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.Make.IO)</title><link rel="stylesheet" href="../../../../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="../../../../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">ezcurl</a> &#x00BB; <a href="../../index.html">Ezcurl_core</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.IO</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 t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>

View file

@ -1,11 +1,37 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (ezcurl.Ezcurl_core.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.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" id="argument-1-IO" class="anchored"><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 type" id="type-io" class="anchored"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span><span> = <span><span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-http" class="anchored"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (ezcurl.Ezcurl_core.Make)</title><link rel="stylesheet" href="../../../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="../../../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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.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 type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span><span> = <span><span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http :
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>General purpose HTTP call via cURL.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">url</span> <p>the URL to query</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">meth</span> <p>which method to use (see <code>meth</code>)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tries</span> <p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">client</span> <p>a client to reuse (instead of allocating a new one)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">range</span> <p>an optional <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests">byte range</a> to fetch (either to get large pages by chunks, or to resume an interrupted download).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to set</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">content</span> <p>the content to send as the query's body, either a <code>`String s</code> to write a single string, or <code>`Write f</code> where <code>f</code> is a callback that is called on a buffer <code>b</code> with len <code>n</code> (as in <code>f b n</code>) and returns how many bytes it wrote in the buffer <code>b</code> starting at index <code>0</code> (at most <code>n</code> bytes). It must return <code>0</code> when the content is entirely written, and not before.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">headers</span> <p>headers of the query</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-get" class="anchored"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:GET</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-put" class="anchored"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span> <span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:PUT</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-post" class="anchored"><a href="#val-post" class="anchor"></a><code><span><span class="keyword">val</span> post : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span>
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div></div></body></html> <span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>General purpose HTTP call via cURL.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">url</span> <p>the URL to query</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">meth</span> <p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tries</span> <p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">client</span> <p>a client to reuse (instead of allocating a new one)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">range</span> <p>an optional <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests">byte range</a> to fetch (either to get large pages by chunks, or to resume an interrupted download).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to set</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">content</span> <p>the content to send as the query's body, either a <code>`String s</code> to write a single string, or <code>`Write f</code> where <code>f</code> is a callback that is called on a buffer <code>b</code> with len <code>n</code> (as in <code>f b n</code>) and returns how many bytes it wrote in the buffer <code>b</code> starting at index <code>0</code> (at most <code>n</code> bytes). It must return <code>0</code> when the content is entirely written, and not before.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">headers</span> <p>headers of the query</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:GET</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-put"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:PUT</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-post"><a href="#val-post" class="anchor"></a><code><span><span class="keyword">val</span> post :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.IO)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.IO</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#underlying-io-monad">Underlying IO Monad</a></li></ul></nav><div class="odoc-content"><h3 id="underlying-io-monad"><a href="#underlying-io-monad" class="anchor"></a>Underlying IO Monad</h3><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-return" class="anchored"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(&gt;&gt;=)" class="anchored"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-(&gt;|=)" class="anchored"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-fail" class="anchored"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-perform" class="anchored"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.IO)</title><link rel="stylesheet" href="../../../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="../../../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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.IO</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#underlying-io-monad">Underlying IO Monad</a></li></ul></nav><div class="odoc-content"><h3 id="underlying-io-monad"><a href="#underlying-io-monad" class="anchor"></a>Underlying IO Monad</h3><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 t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>

View file

@ -1,11 +1,37 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl_core.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.S</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#main-signature">Main Signature</a></li></ul></nav><div class="odoc-content"><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3><div class="odoc-spec"><div class="spec type" id="type-io" class="anchored"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-http" class="anchored"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl_core.S)</title><link rel="stylesheet" href="../../../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="../../../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">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.S</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#main-signature">Main Signature</a></li></ul></nav><div class="odoc-content"><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3><div class="odoc-spec"><div class="spec type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http :
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>General purpose HTTP call via cURL.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">url</span> <p>the URL to query</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">meth</span> <p>which method to use (see <code>meth</code>)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tries</span> <p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">client</span> <p>a client to reuse (instead of allocating a new one)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">range</span> <p>an optional <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests">byte range</a> to fetch (either to get large pages by chunks, or to resume an interrupted download).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to set</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">content</span> <p>the content to send as the query's body, either a <code>`String s</code> to write a single string, or <code>`Write f</code> where <code>f</code> is a callback that is called on a buffer <code>b</code> with len <code>n</code> (as in <code>f b n</code>) and returns how many bytes it wrote in the buffer <code>b</code> starting at index <code>0</code> (at most <code>n</code> bytes). It must return <code>0</code> when the content is entirely written, and not before.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">headers</span> <p>headers of the query</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-get" class="anchored"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:GET</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-put" class="anchored"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span> <span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:PUT</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-post" class="anchored"><a href="#val-post" class="anchor"></a><code><span><span class="keyword">val</span> post : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span>
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div></div></body></html> <span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>General purpose HTTP call via cURL.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">url</span> <p>the URL to query</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">meth</span> <p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tries</span> <p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">client</span> <p>a client to reuse (instead of allocating a new one)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">range</span> <p>an optional <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests">byte range</a> to fetch (either to get large pages by chunks, or to resume an interrupted download).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to set</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">content</span> <p>the content to send as the query's body, either a <code>`String s</code> to write a single string, or <code>`Write f</code> where <code>f</code> is a callback that is called on a buffer <code>b</code> with len <code>n</code> (as in <code>f b n</code>) and returns how many bytes it wrote in the buffer <code>b</code> starting at index <code>0</code> (at most <code>n</code> bytes). It must return <code>0</code> when the content is entirely written, and not before.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">headers</span> <p>headers of the query</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:GET</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-put"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:PUT</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-post"><a href="#val-post" class="anchor"></a><code><span><span class="keyword">val</span> post :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<a href="../index.html#type-response">response</a>, <span class="xref-unresolved">Curl</span>.curlCode * string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <a href="#type-io">io</a></span></span></code></div><div class="spec-doc"><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="#val-http"><code>http</code></a> for more info.</p></div></div></div></body></html>

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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> ezcurl</nav><header class="odoc-preamble"><h1 id="ezcurl-index"><a href="#ezcurl-index" class="anchor"></a>ezcurl index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl">Library ezcurl</a></li><li><a href="#library-ezcurl.core">Library ezcurl.core</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl"><a href="#library-ezcurl" class="anchor"></a>Library ezcurl</h2><p>The entry point of this library is the module: <a href="Ezcurl/index.html"><code>Ezcurl</code></a>.</p><h2 id="library-ezcurl.core"><a href="#library-ezcurl.core" class="anchor"></a>Library ezcurl.core</h2><p>The entry point of this library is the module: <a href="Ezcurl_core/index.html"><code>Ezcurl_core</code></a>.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl.index)</title><link rel="stylesheet" href="../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="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl</nav><header class="odoc-preamble"><h1 id="ezcurl-index"><a href="#ezcurl-index" class="anchor"></a>ezcurl index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl">Library ezcurl</a></li><li><a href="#library-ezcurl.core">Library ezcurl.core</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl"><a href="#library-ezcurl" class="anchor"></a>Library ezcurl</h2><p>The entry point of this library is the module: <a href="Ezcurl/index.html"><code>Ezcurl</code></a>.</p><h2 id="library-ezcurl.core"><a href="#library-ezcurl.core" class="anchor"></a>Library ezcurl.core</h2><p>The entry point of this library is the module: <a href="Ezcurl_core/index.html"><code>Ezcurl_core</code></a>.</p></div></body></html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

1
dev/katex.min.css vendored Normal file

File diff suppressed because one or more lines are too long

1
dev/katex.min.js vendored Normal file

File diff suppressed because one or more lines are too long

View file

@ -1,7 +1,7 @@
@charset "UTF-8"; @charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved. /* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. Distributed under the ISC license, see terms at the end of the file.
odoc 2.0.0 */ odoc 2.2.0 */
/* Fonts */ /* Fonts */
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500'); @import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
@ -124,7 +124,6 @@
/* Reset a few things. */ /* Reset a few things. */
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video { html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0; padding: 0;
border: 0; border: 0;
font: inherit; font: inherit;
@ -153,7 +152,7 @@ body {
} }
body { body {
max-width: 90ex; max-width: 100ex;
margin-left: calc(10vw + 20ex); margin-left: calc(10vw + 20ex);
margin-right: 4ex; margin-right: 4ex;
margin-top: 20px; margin-top: 20px;
@ -202,15 +201,6 @@ sup, sub {
margin-left: 0.2ex; margin-left: 0.2ex;
} }
pre {
margin-top: 0.8em;
margin-bottom: 1.2em;
}
p, ul, ol {
margin-top: 0.5em;
margin-bottom: 1em;
}
ul, ol { ul, ol {
list-style-position: outside list-style-position: outside
} }
@ -306,7 +296,6 @@ a.anchor {
h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 { h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
font-family: "Fira Sans", Helvetica, Arial, sans-serif; font-family: "Fira Sans", Helvetica, Arial, sans-serif;
font-weight: 400; font-weight: 400;
margin: 0.5em 0 0.5em 0;
padding-top: 0.1em; padding-top: 0.1em;
line-height: 1.2; line-height: 1.2;
overflow-wrap: break-word; overflow-wrap: break-word;
@ -315,7 +304,6 @@ h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
h1 { h1 {
font-weight: 500; font-weight: 500;
font-size: 2.441em; font-size: 2.441em;
margin-top: 1.214em;
} }
h1 { h1 {
@ -403,6 +391,10 @@ p a > code {
color: var(--link-color); color: var(--link-color);
} }
code {
white-space: pre-wrap;
}
/* Code blocks (e.g. Examples) */ /* Code blocks (e.g. Examples) */
pre code { pre code {
@ -427,23 +419,44 @@ pre code {
padding: 0.35em 0.5em; padding: 0.35em 0.5em;
} }
div.spec, .def-doc { li:not(:last-child) > .def-doc {
margin-bottom: 20px; margin-bottom: 15px;
} }
.spec.type .variant { /* Spacing between items */
div.odoc-spec,.odoc-include {
margin-bottom: 2em;
}
.spec.type .variant p, .spec.type .record p {
margin: 5px;
}
.spec.type .variant, .spec.type .record {
margin-left: 2ch; margin-left: 2ch;
list-style: none;
display: flex;
flex-wrap: wrap;
row-gap: 4px;
} }
.spec.type .variant p {
margin: 0; .spec.type .record > code, .spec.type .variant > code {
font-style: italic; min-width: 40%;
} }
.spec.type .record {
margin-left: 2ch; .spec.type > ol {
margin-top: 0;
margin-bottom: 0;
} }
.spec.type .record p {
margin: 0; .spec.type .record > .def-doc, .spec.type .variant > .def-doc {
font-style: italic; min-width:50%;
padding: 0.25em 0.5em;
margin-left: 10%;
border-radius: 3px;
flex-grow:1;
background: var(--main-background);
box-shadow: 2px 2px 4px lightgrey;
} }
div.def { div.def {
@ -452,11 +465,6 @@ div.def {
padding-left: 2ex; padding-left: 2ex;
} }
div.def+div.def-doc {
margin-left: 1ex;
margin-top: 2.5px
}
div.def-doc>*:first-child { div.def-doc>*:first-child {
margin-top: 0; margin-top: 0;
} }
@ -467,6 +475,10 @@ div.def-doc>*:first-child {
position: relative; position: relative;
} }
.odoc-include.shadowed-include {
display: none;
}
.odoc-include details:after { .odoc-include details:after {
z-index: -100; z-index: -100;
display: block; display: block;
@ -483,7 +495,7 @@ div.def-doc>*:first-child {
.odoc-include summary { .odoc-include summary {
position: relative; position: relative;
margin-bottom: 20px; margin-bottom: 1em;
cursor: pointer; cursor: pointer;
outline: none; outline: none;
} }
@ -665,9 +677,8 @@ td.def-doc *:first-child {
/* Mobile adjustements. */ /* Mobile adjustements. */
@media only screen and (max-width: 95ex) { @media only screen and (max-width: 95ex) {
.odoc-content { body.odoc {
margin: auto; margin: 2em;
padding: 2em;
} }
.odoc-toc { .odoc-toc {
position: static; position: static;
@ -677,6 +688,7 @@ td.def-doc *:first-child {
border: none; border: none;
padding: 0.2em 1em; padding: 0.2em 1em;
border-radius: 5px; border-radius: 5px;
margin-bottom: 2em;
} }
} }