mirror of
https://github.com/c-cube/ezcurl.git
synced 2025-12-06 03:05:31 -05:00
deploy: d259d85eb7
This commit is contained in:
parent
0b4a2dd215
commit
28977eeed4
23 changed files with 616 additions and 237 deletions
File diff suppressed because one or more lines are too long
|
|
@ -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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – 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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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> – 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
|
|
@ -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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</span></code></h1><p>Configuration for the client.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-username"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-password"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></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">-></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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</span></code></h1><p>Configuration for the client.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-username"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-password"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></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">-></span></span> string</span></code></div></div></div></body></html>
|
||||||
|
|
|
||||||
|
|
@ -1,2 +1,2 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.Make.IO)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">ezcurl</a> » <a href="../../index.html">Ezcurl_core</a> » <a href="../index.html">Make</a> » 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">-></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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></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-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span><span class="keyword">val</span> (>|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#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">-></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">-></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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">ezcurl</a> » <a href="../../index.html">Ezcurl_core</a> » <a href="../index.html">Make</a> » 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">-></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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></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-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span><span class="keyword">val</span> (>|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#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">-></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">-></span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>
|
||||||
|
|
|
||||||
|
|
@ -1,37 +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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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 :
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (ezcurl.Ezcurl_core.Make)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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>?tries:int <span class="arrow">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?range:string <span class="arrow">-></span></span>
|
<span><span class="optlabel">?range</span>:string <span class="arrow">-></span></span>
|
||||||
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">-></span></span>
|
<span><span class="label">meth</span>:<a href="../index.html#type-meth">meth</a> <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?range:string <span class="arrow">-></span></span>
|
<span><span class="optlabel">?range</span>:string <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="label">content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">-></span></span>
|
<span><span class="label">params</span>:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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
|
|
@ -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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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">-></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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></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-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span><span class="keyword">val</span> (>|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#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">-></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">-></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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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">-></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-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></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-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span><span class="keyword">val</span> (>|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#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">-></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">-></span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>
|
||||||
|
|
|
||||||
|
|
@ -1,37 +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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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 :
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl_core.S)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » 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>?tries:int <span class="arrow">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?range:string <span class="arrow">-></span></span>
|
<span><span class="optlabel">?range</span>:string <span class="arrow">-></span></span>
|
||||||
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>meth:<a href="../index.html#type-meth">meth</a> <span class="arrow">-></span></span>
|
<span><span class="label">meth</span>:<a href="../index.html#type-meth">meth</a> <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?range:string <span class="arrow">-></span></span>
|
<span><span class="optlabel">?range</span>:string <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="label">content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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">-></span></span>
|
<span><span class="optlabel">?tries</span>:int <span class="arrow">-></span></span>
|
||||||
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?client</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span>
|
||||||
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||||
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
<span><span class="optlabel">?content</span>:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span> ]</span> <span class="arrow">-></span></span>
|
||||||
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">-></span></span>
|
<span><span class="label">params</span>:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">-></span></span>
|
||||||
<span>url:string <span class="arrow">-></span></span>
|
<span><span class="label">url</span>:string <span class="arrow">-></span></span>
|
||||||
<span>unit <span class="arrow">-></span></span>
|
<span>unit <span class="arrow">-></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><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>
|
||||||
|
|
@ -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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – 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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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> – 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>
|
||||||
|
|
|
||||||
BIN
dev/odoc.support/fonts/fira-mono-v14-latin-500.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-mono-v14-latin-500.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-mono-v14-latin-regular.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-mono-v14-latin-regular.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-500.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-500.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-700.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-700.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-italic.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-italic.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-regular.woff2
Normal file
BIN
dev/odoc.support/fonts/fira-sans-v17-latin-regular.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-700.woff2
Normal file
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-700.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-italic.woff2
Normal file
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-italic.woff2
Normal file
Binary file not shown.
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-regular.woff2
Normal file
BIN
dev/odoc.support/fonts/noticia-text-v15-latin-regular.woff2
Normal file
Binary file not shown.
File diff suppressed because one or more lines are too long
|
|
@ -1,12 +1,97 @@
|
||||||
@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.2.0 */
|
odoc 2.3.0 */
|
||||||
|
|
||||||
/* Fonts */
|
/* Fonts */
|
||||||
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
|
/* noticia-text-regular - latin */
|
||||||
@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700');
|
@font-face {
|
||||||
@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i');
|
font-family: 'Noticia Text';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('fonts/noticia-text-v15-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* noticia-text-italic - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Noticia Text';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('fonts/noticia-text-v15-latin-italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* noticia-text-700 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Noticia Text';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 700;
|
||||||
|
src: url('fonts/noticia-text-v15-latin-700.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-mono-regular - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Mono';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('fonts/fira-mono-v14-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-mono-500 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Mono';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 500;
|
||||||
|
src: url('fonts/fira-mono-v14-latin-500.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-regular - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-italic - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-500 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 500;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-500.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-500italic - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 500;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-500italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-700 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 700;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-700.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* fira-sans-700italic - latin */
|
||||||
|
@font-face {
|
||||||
|
font-family: 'Fira Sans';
|
||||||
|
font-style: italic;
|
||||||
|
font-weight: 700;
|
||||||
|
src: url('fonts/fira-sans-v17-latin-700italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
:root,
|
:root,
|
||||||
.light:root {
|
.light:root {
|
||||||
|
|
@ -14,6 +99,7 @@
|
||||||
|
|
||||||
--color: #333333;
|
--color: #333333;
|
||||||
--link-color: #2C94BD;
|
--link-color: #2C94BD;
|
||||||
|
--source-color: grey;
|
||||||
--anchor-hover: #555;
|
--anchor-hover: #555;
|
||||||
--anchor-color: #d5d5d5;
|
--anchor-color: #d5d5d5;
|
||||||
--xref-shadow: #cc6666;
|
--xref-shadow: #cc6666;
|
||||||
|
|
@ -33,6 +119,7 @@
|
||||||
--toc-list-border: #ccc;
|
--toc-list-border: #ccc;
|
||||||
|
|
||||||
--spec-summary-border-color: #5c9cf5;
|
--spec-summary-border-color: #5c9cf5;
|
||||||
|
--spec-label-color: green;
|
||||||
--spec-summary-background: var(--code-background);
|
--spec-summary-background: var(--code-background);
|
||||||
--spec-summary-hover-background: #ebeff2;
|
--spec-summary-hover-background: #ebeff2;
|
||||||
--spec-details-after-background: rgba(0, 4, 15, 0.05);
|
--spec-details-after-background: rgba(0, 4, 15, 0.05);
|
||||||
|
|
@ -72,6 +159,8 @@
|
||||||
--hljs-type: #ac885b;
|
--hljs-type: #ac885b;
|
||||||
--hljs-meta: #82aaff;
|
--hljs-meta: #82aaff;
|
||||||
--hljs-variable: #cf6a4c;
|
--hljs-variable: #cf6a4c;
|
||||||
|
|
||||||
|
--spec-label-color: lightgreen;
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
@media (prefers-color-scheme: dark) {
|
||||||
|
|
@ -118,6 +207,8 @@
|
||||||
--hljs-type: #ac885b;
|
--hljs-type: #ac885b;
|
||||||
--hljs-meta: #82aaff;
|
--hljs-meta: #82aaff;
|
||||||
--hljs-variable: #cf6a4c;
|
--hljs-variable: #cf6a4c;
|
||||||
|
|
||||||
|
--spec-label-color: lightgreen;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -142,6 +233,7 @@ table {
|
||||||
|
|
||||||
html {
|
html {
|
||||||
font-size: 15px;
|
font-size: 15px;
|
||||||
|
scroll-behavior: smooth;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
|
|
@ -149,16 +241,23 @@ body {
|
||||||
background: #FFFFFF;
|
background: #FFFFFF;
|
||||||
color: var(--color);
|
color: var(--color);
|
||||||
background-color: var(--main-background);
|
background-color: var(--main-background);
|
||||||
|
font-family: "Noticia Text", Georgia, serif;
|
||||||
|
line-height: 1.5;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
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;
|
||||||
margin-bottom: 50px;
|
margin-bottom: 50px;
|
||||||
font-family: "Noticia Text", Georgia, serif;
|
}
|
||||||
line-height: 1.5;
|
|
||||||
|
body.odoc {
|
||||||
|
max-width: 100ex;
|
||||||
|
}
|
||||||
|
|
||||||
|
body.odoc-src {
|
||||||
|
margin-right: calc(10vw + 20ex);
|
||||||
}
|
}
|
||||||
|
|
||||||
header {
|
header {
|
||||||
|
|
@ -238,6 +337,10 @@ a {
|
||||||
color: var(--link-color);
|
color: var(--link-color);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.odoc-src pre a {
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
a:hover {
|
a:hover {
|
||||||
box-shadow: 0 1px 0 0 var(--link-color);
|
box-shadow: 0 1px 0 0 var(--link-color);
|
||||||
}
|
}
|
||||||
|
|
@ -289,6 +392,14 @@ a.anchor {
|
||||||
box-shadow: 0 1px 0 0 var(--xref-shadow);
|
box-shadow: 0 1px 0 0 var(--xref-shadow);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Source links float inside preformated text or headings. */
|
||||||
|
a.source_link {
|
||||||
|
float: right;
|
||||||
|
color: var(--source-color);
|
||||||
|
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
|
||||||
|
font-size: initial;
|
||||||
|
}
|
||||||
|
|
||||||
/* Section and document divisions.
|
/* Section and document divisions.
|
||||||
Until at least 4.03 many of the modules of the stdlib start at .h7,
|
Until at least 4.03 many of the modules of the stdlib start at .h7,
|
||||||
we restart the sequence there like h2 */
|
we restart the sequence there like h2 */
|
||||||
|
|
@ -372,32 +483,32 @@ tt, code, pre {
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
}
|
}
|
||||||
|
|
||||||
pre {
|
.odoc pre {
|
||||||
padding: 0.1em;
|
padding: 0.1em;
|
||||||
border: 1px solid var(--pre-border-color);
|
border: 1px solid var(--pre-border-color);
|
||||||
border-radius: 5px;
|
border-radius: 5px;
|
||||||
overflow-x: auto;
|
overflow-x: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
p code,
|
.odoc p code,
|
||||||
li code {
|
.odoc li code {
|
||||||
background-color: var(--li-code-background);
|
background-color: var(--li-code-background);
|
||||||
color: var(--li-code-color);
|
color: var(--li-code-color);
|
||||||
border-radius: 3px;
|
border-radius: 3px;
|
||||||
padding: 0 0.3ex;
|
padding: 0 0.3ex;
|
||||||
}
|
}
|
||||||
|
|
||||||
p a > code {
|
p a > code, li a > code {
|
||||||
color: var(--link-color);
|
color: var(--link-color);
|
||||||
}
|
}
|
||||||
|
|
||||||
code {
|
.odoc code {
|
||||||
white-space: pre-wrap;
|
white-space: pre-wrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Code blocks (e.g. Examples) */
|
/* Code blocks (e.g. Examples) */
|
||||||
|
|
||||||
pre code {
|
.odoc pre code {
|
||||||
font-size: 0.893rem;
|
font-size: 0.893rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -419,6 +530,10 @@ pre code {
|
||||||
padding: 0.35em 0.5em;
|
padding: 0.35em 0.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.spec .label, .spec .optlabel {
|
||||||
|
color: var(--spec-label-color);
|
||||||
|
}
|
||||||
|
|
||||||
li:not(:last-child) > .def-doc {
|
li:not(:last-child) > .def-doc {
|
||||||
margin-bottom: 15px;
|
margin-bottom: 15px;
|
||||||
}
|
}
|
||||||
|
|
@ -536,6 +651,12 @@ td.def-doc *:first-child {
|
||||||
.at-tags li { padding-left: 3ex; text-indent: -3ex; }
|
.at-tags li { padding-left: 3ex; text-indent: -3ex; }
|
||||||
.at-tags .at-tag { text-transform: capitalize }
|
.at-tags .at-tag { text-transform: capitalize }
|
||||||
|
|
||||||
|
/* Alert emoji */
|
||||||
|
|
||||||
|
.alert::before, .deprecated::before {
|
||||||
|
content: '⚠️ ';
|
||||||
|
}
|
||||||
|
|
||||||
/* Lists of modules */
|
/* Lists of modules */
|
||||||
|
|
||||||
.modules { list-style-type: none; margin-left: -3ex; }
|
.modules { list-style-type: none; margin-left: -3ex; }
|
||||||
|
|
@ -674,10 +795,26 @@ td.def-doc *:first-child {
|
||||||
padding-left: 12px;
|
padding-left: 12px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Tables */
|
||||||
|
|
||||||
|
.odoc-table {
|
||||||
|
margin: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.odoc-table td, .odoc-table th {
|
||||||
|
padding-left: 0.5em;
|
||||||
|
padding-right: 0.5em;
|
||||||
|
border: 1px solid black;
|
||||||
|
}
|
||||||
|
|
||||||
|
.odoc-table th {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
/* Mobile adjustements. */
|
/* Mobile adjustements. */
|
||||||
|
|
||||||
@media only screen and (max-width: 95ex) {
|
@media only screen and (max-width: 110ex) {
|
||||||
body.odoc {
|
body {
|
||||||
margin: 2em;
|
margin: 2em;
|
||||||
}
|
}
|
||||||
.odoc-toc {
|
.odoc-toc {
|
||||||
|
|
@ -704,6 +841,47 @@ td.def-doc *:first-child {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Source code. */
|
||||||
|
|
||||||
|
.source_container {
|
||||||
|
display: flex;
|
||||||
|
}
|
||||||
|
|
||||||
|
.source_line_column {
|
||||||
|
padding-right: 0.5em;
|
||||||
|
text-align: right;
|
||||||
|
background: #eee8d5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.source_line {
|
||||||
|
padding: 0 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.source_code {
|
||||||
|
flex-grow: 1;
|
||||||
|
background: #fdf6e3;
|
||||||
|
padding: 0 0.3em;
|
||||||
|
color: #657b83;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Source directories */
|
||||||
|
|
||||||
|
.odoc-directory::before {
|
||||||
|
content: "📁";
|
||||||
|
margin: 0.3em;
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.odoc-file::before {
|
||||||
|
content: "📄";
|
||||||
|
margin: 0.3em;
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.odoc-folder-list {
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
/* Syntax highlighting (based on github-gist) */
|
/* Syntax highlighting (based on github-gist) */
|
||||||
|
|
||||||
.hljs {
|
.hljs {
|
||||||
|
|
@ -777,6 +955,34 @@ td.def-doc *:first-child {
|
||||||
text-decoration: underline;
|
text-decoration: underline;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.VAL, .TYPE, .LET, .REC, .IN, .OPEN, .NONREC, .MODULE, .METHOD, .LETOP, .INHERIT, .INCLUDE, .FUNCTOR, .EXTERNAL, .CONSTRAINT, .ASSERT, .AND, .END, .CLASS, .STRUCT, .SIG {
|
||||||
|
color: #859900;;
|
||||||
|
}
|
||||||
|
|
||||||
|
.WITH, .WHILE, .WHEN, .VIRTUAL, .TRY, .TO, .THEN, .PRIVATE, .OF, .NEW, .MUTABLE, .MATCH, .LAZY, .IF, .FUNCTION, .FUN, .FOR, .EXCEPTION, .ELSE, .TO, .DOWNTO, .DO, .DONE, .BEGIN, .AS {
|
||||||
|
color: #cb4b16;
|
||||||
|
}
|
||||||
|
|
||||||
|
.TRUE, .FALSE {
|
||||||
|
color: #b58900;
|
||||||
|
}
|
||||||
|
|
||||||
|
.failwith, .INT, .SEMISEMI, .LIDENT {
|
||||||
|
color: #2aa198;
|
||||||
|
}
|
||||||
|
|
||||||
|
.STRING, .CHAR, .UIDENT {
|
||||||
|
color: #b58900;
|
||||||
|
}
|
||||||
|
|
||||||
|
.DOCSTRING {
|
||||||
|
color: #268bd2;
|
||||||
|
}
|
||||||
|
|
||||||
|
.COMMENT {
|
||||||
|
color: #93a1a1;
|
||||||
|
}
|
||||||
|
|
||||||
/*---------------------------------------------------------------------------
|
/*---------------------------------------------------------------------------
|
||||||
Copyright (c) 2016 The odoc contributors
|
Copyright (c) 2016 The odoc contributors
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue