mirror of
https://github.com/c-cube/ezcurl.git
synced 2025-12-10 05:03:59 -05:00
update dev doc
This commit is contained in:
Simon Cruanes
parent
ca04e44ca2
commit
9d2338c9d2
8 changed files with 8 additions and 8 deletions
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl-lwt.Ezcurl_lwt.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl-lwt</a> » <a href="../index.html">Ezcurl_lwt</a> » S</nav><h1>Module type <code>Ezcurl_lwt.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt></dl></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl-lwt.Ezcurl_lwt.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl-lwt</a> » <a href="../index.html">Ezcurl_lwt</a> » S</nav><h1>Module type <code>Ezcurl_lwt.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>General purpose HTTP call via cURL.</p><dl><dt>parameter url</dt><dd><p>the URL to query</p></dd></dl><dl><dt>parameter meth</dt><dd><p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></dd></dl><dl><dt>parameter tries</dt><dd><p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></dd></dl><dl><dt>parameter client</dt><dd><p>a client to reuse (instead of allocating a new one)</p></dd></dl><dl><dt>parameter range</dt><dd><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></dd></dl><dl><dt>parameter config</dt><dd><p>configuration to set</p></dd></dl><dl><dt>parameter headers</dt><dd><p>headers of the query</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:GET</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-put"><a href="#val-put" class="anchor"></a><code><span class="keyword">val</span> put : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:PUT</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-post"><a href="#val-post" class="anchor"></a><code><span class="keyword">val</span> post : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> params:Curl.curlHTTPPost list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl</a> » S</nav><h1>Module type <code>Ezcurl.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt></dl></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl</a> » S</nav><h1>Module type <code>Ezcurl.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>General purpose HTTP call via cURL.</p><dl><dt>parameter url</dt><dd><p>the URL to query</p></dd></dl><dl><dt>parameter meth</dt><dd><p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></dd></dl><dl><dt>parameter tries</dt><dd><p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></dd></dl><dl><dt>parameter client</dt><dd><p>a client to reuse (instead of allocating a new one)</p></dd></dl><dl><dt>parameter range</dt><dd><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></dd></dl><dl><dt>parameter config</dt><dd><p>configuration to set</p></dd></dl><dl><dt>parameter headers</dt><dd><p>headers of the query</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:GET</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-put"><a href="#val-put" class="anchor"></a><code><span class="keyword">val</span> put : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:PUT</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-post"><a href="#val-post" class="anchor"></a><code><span class="keyword">val</span> post : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> params:Curl.curlHTTPPost list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Config</nav><h1>Module <code>Ezcurl_core.Config</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-default"><a href="#val-default" class="anchor"></a><code><span class="keyword">val</span> default : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span class="keyword">val</span> verbose : bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-authmethod"><a href="#val-authmethod" class="anchor"></a><code><span class="keyword">val</span> authmethod : Curl.curlAuth list <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span class="keyword">val</span> max_redirects : int <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span class="keyword">val</span> follow_location : bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-username"><a href="#val-username" class="anchor"></a><code><span class="keyword">val</span> username : string <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-password"><a href="#val-password" class="anchor"></a><code><span class="keyword">val</span> password : string <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt></dl></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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Config</nav><h1>Module <code>Ezcurl_core.Config</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-default"><a href="#val-default" class="anchor"></a><code><span class="keyword">val</span> default : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span class="keyword">val</span> verbose : bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-authmethod"><a href="#val-authmethod" class="anchor"></a><code><span class="keyword">val</span> authmethod : Curl.curlAuth list <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span class="keyword">val</span> max_redirects : int <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span class="keyword">val</span> follow_location : bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-username"><a href="#val-username" class="anchor"></a><code><span class="keyword">val</span> username : string <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-password"><a href="#val-password" class="anchor"></a><code><span class="keyword">val</span> password : string <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : Format.formatter <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <a href="index.html#type-t">t</a> <span>-></span> string</code></dt></dl></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Make</nav><h1>Module <code>Ezcurl_core.Make</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-IO/index.html">IO</a> : <a href="../index.html#module-type-IO">IO</a></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code><code> = <span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt></dl></div></body></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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » Make</nav><h1>Module <code>Ezcurl_core.Make</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-IO/index.html">IO</a> : <a href="../index.html#module-type-IO">IO</a></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code><code> = <span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>General purpose HTTP call via cURL.</p><dl><dt>parameter url</dt><dd><p>the URL to query</p></dd></dl><dl><dt>parameter meth</dt><dd><p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></dd></dl><dl><dt>parameter tries</dt><dd><p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></dd></dl><dl><dt>parameter client</dt><dd><p>a client to reuse (instead of allocating a new one)</p></dd></dl><dl><dt>parameter range</dt><dd><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></dd></dl><dl><dt>parameter config</dt><dd><p>configuration to set</p></dd></dl><dl><dt>parameter headers</dt><dd><p>headers of the query</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:GET</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-put"><a href="#val-put" class="anchor"></a><code><span class="keyword">val</span> put : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:PUT</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-post"><a href="#val-post" class="anchor"></a><code><span class="keyword">val</span> post : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> params:Curl.curlHTTPPost list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » S</nav><h1>Module type <code>Ezcurl_core.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt></dl></div></body></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="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">ezcurl</a> » <a href="../index.html">Ezcurl_core</a> » S</nav><h1>Module type <code>Ezcurl_core.S</code></h1><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3></header><dl><dt class="spec type" id="type-io"><a href="#type-io" class="anchor"></a><code><span class="keyword">type</span> 'a io</code></dt></dl><dl><dt class="spec value" id="val-http"><a href="#val-http" class="anchor"></a><code><span class="keyword">val</span> http : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> meth:<a href="../index.html#type-meth">meth</a> <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>General purpose HTTP call via cURL.</p><dl><dt>parameter url</dt><dd><p>the URL to query</p></dd></dl><dl><dt>parameter meth</dt><dd><p>which method to use (see <a href="../index.html#type-meth"><code>meth</code></a>)</p></dd></dl><dl><dt>parameter tries</dt><dd><p>how many times to retry in case of <code>CURLE_AGAIN</code> code</p></dd></dl><dl><dt>parameter client</dt><dd><p>a client to reuse (instead of allocating a new one)</p></dd></dl><dl><dt>parameter range</dt><dd><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></dd></dl><dl><dt>parameter config</dt><dd><p>configuration to set</p></dd></dl><dl><dt>parameter headers</dt><dd><p>headers of the query</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠range:string <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:GET</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-put"><a href="#val-put" class="anchor"></a><code><span class="keyword">val</span> put : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:PUT</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl><dl><dt class="spec value" id="val-post"><a href="#val-post" class="anchor"></a><code><span class="keyword">val</span> post : ?⁠tries:int <span>-></span> ?⁠client:<a href="../index.html#type-t">t</a> <span>-></span> ?⁠config:<a href="../Config/index.html#type-t">Config.t</a> <span>-></span> ?⁠headers:(string * string) list <span>-></span> params:Curl.curlHTTPPost list <span>-></span> url:string <span>-></span> unit <span>-></span> (<a href="../index.html#type-response">response</a>, Curl.curlCode * string) Pervasives.result <a href="index.html#type-io">io</a></code></dt><dd><p>Shortcut for <code>http ~meth:(POST params)</code> See <a href="index.html#val-http"><code>http</code></a> for more info.</p></dd></dl></div></body></html>
|
||||
Loading…
Add table
Reference in a new issue