mirror of
https://github.com/c-cube/ezcurl.git
synced 2026-01-23 18:06:41 -05:00
37 lines
9.5 KiB
HTML
37 lines
9.5 KiB
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.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><span class="optlabel">?tries</span>:int <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><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?range</span>:string <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><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">url</span>:string <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><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 class="optlabel">?tries</span>:int <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><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?range</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <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><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 class="optlabel">?tries</span>:int <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><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">url</span>:string <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><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 class="optlabel">?tries</span>:int <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><span class="optlabel">?config</span>:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?headers</span>:<span><span>(string * string)</span> list</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><span class="label">params</span>:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <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><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>
|