simon/ezcurl
1
0
Fork 0
mirror of https://github.com/c-cube/ezcurl.git synced 2025-12-06 03:05:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
ezcurl/dev/ezcurl-lwt/Ezcurl_lwt/index.html
c-cube da5c60ffc5 deploy: c568f9e4e3
2021-10-07 17:16:25 +00:00

11 lines
No EOL
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ezcurl_lwt (ezcurl-lwt.Ezcurl_lwt)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">ezcurl-lwt</a> &#x00BB; Ezcurl_lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_lwt</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../ezcurl/Ezcurl_core/index.html">Ezcurl_core</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec module" id="module-Config" class="anchored"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>Config</span><span> = <a href="../../ezcurl/Ezcurl_core/Config/index.html">Ezcurl_core.Config</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span class="xref-unresolved">Curl</span>.t</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-make" class="anchored"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span>?set_opts:<span>(<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-delete" class="anchored"><a href="#val-delete" class="anchor"></a><code><span><span class="keyword">val</span> delete : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-with_client" class="anchored"><a href="#val-with_client" class="anchor"></a><code><span><span class="keyword">val</span> with_client : <span>?set_opts:<span>(<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Make a temporary client, call the function with it, then cleanup</p></div></div><div class="odoc-spec"><div class="spec type" id="type-response_info" class="anchored"><a href="#type-response_info" class="anchor"></a><code><span><span class="keyword">type</span> response_info</span><span> = <a href="../../ezcurl/Ezcurl_core/index.html#type-response_info">Ezcurl_core.response_info</a></span><span> = </span><span>{</span></code><table><tr id="type-response_info.ri_response_time" class="anchored"><td class="def record field"><a href="#type-response_info.ri_response_time" class="anchor"></a><code><span>ri_response_time : float;</span></code></td></tr><tr id="type-response_info.ri_redirect_count" class="anchored"><td class="def record field"><a href="#type-response_info.ri_redirect_count" class="anchor"></a><code><span>ri_redirect_count : int;</span></code></td></tr></table><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-pp_response_info" class="anchored"><a href="#val-pp_response_info" class="anchor"></a><code><span><span class="keyword">val</span> pp_response_info : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-response_info">response_info</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-string_of_response_info" class="anchored"><a href="#val-string_of_response_info" class="anchor"></a><code><span><span class="keyword">val</span> string_of_response_info : <span><a href="#type-response_info">response_info</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-response" class="anchored"><a href="#type-response" class="anchor"></a><code><span><span class="keyword">type</span> response</span><span> = <a href="../../ezcurl/Ezcurl_core/index.html#type-response">Ezcurl_core.response</a></span><span> = </span><span>{</span></code><table><tr id="type-response.code" class="anchored"><td class="def record field"><a href="#type-response.code" class="anchor"></a><code><span>code : int;</span></code></td></tr><tr id="type-response.headers" class="anchored"><td class="def record field"><a href="#type-response.headers" class="anchor"></a><code><span>headers : <span><span>(string * string)</span> list</span>;</span></code></td></tr><tr id="type-response.body" class="anchored"><td class="def record field"><a href="#type-response.body" class="anchor"></a><code><span>body : string;</span></code></td></tr><tr id="type-response.info" class="anchored"><td class="def record field"><a href="#type-response.info" class="anchor"></a><code><span>info : <a href="#type-response_info">response_info</a>;</span></code></td></tr></table><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-pp_response" class="anchored"><a href="#val-pp_response" class="anchor"></a><code><span><span class="keyword">val</span> pp_response : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-response">response</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-string_of_response" class="anchored"><a href="#val-string_of_response" class="anchor"></a><code><span><span class="keyword">val</span> string_of_response : <span><a href="#type-response">response</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-meth" class="anchored"><a href="#type-meth" class="anchor"></a><code><span><span class="keyword">type</span> meth</span><span> = <a href="../../ezcurl/Ezcurl_core/index.html#type-meth">Ezcurl_core.meth</a></span><span> = </span></code><table><tr id="type-meth.GET" class="anchored"><td class="def variant constructor"><a href="#type-meth.GET" class="anchor"></a><code><span>| </span><span><span class="constructor">GET</span></span></code></td></tr><tr id="type-meth.POST" class="anchored"><td class="def variant constructor"><a href="#type-meth.POST" class="anchor"></a><code><span>| </span><span><span class="constructor">POST</span> <span class="keyword">of</span> <span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span></span></code></td></tr><tr id="type-meth.PUT" class="anchored"><td class="def variant constructor"><a href="#type-meth.PUT" class="anchor"></a><code><span>| </span><span><span class="constructor">PUT</span></span></code></td></tr><tr id="type-meth.DELETE" class="anchored"><td class="def variant constructor"><a href="#type-meth.DELETE" class="anchor"></a><code><span>| </span><span><span class="constructor">DELETE</span></span></code></td></tr><tr id="type-meth.HEAD" class="anchored"><td class="def variant constructor"><a href="#type-meth.HEAD" class="anchor"></a><code><span>| </span><span><span class="constructor">HEAD</span></span></code></td></tr><tr id="type-meth.CONNECT" class="anchored"><td class="def variant constructor"><a href="#type-meth.CONNECT" class="anchor"></a><code><span>| </span><span><span class="constructor">CONNECT</span></span></code></td></tr><tr id="type-meth.OPTIONS" class="anchored"><td class="def variant constructor"><a href="#type-meth.OPTIONS" class="anchor"></a><code><span>| </span><span><span class="constructor">OPTIONS</span></span></code></td></tr><tr id="type-meth.TRACE" class="anchored"><td class="def variant constructor"><a href="#type-meth.TRACE" class="anchor"></a><code><span>| </span><span><span class="constructor">TRACE</span></span></code></td></tr><tr id="type-meth.PATCH" class="anchored"><td class="def variant constructor"><a href="#type-meth.PATCH" class="anchor"></a><code><span>| </span><span><span class="constructor">PATCH</span></span></code></td></tr></table></div><div class="spec-doc"><p>The <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods">HTTP method</a> to use</p></div></div><div class="odoc-spec"><div class="spec value" id="val-pp_meth" class="anchored"><a href="#val-pp_meth" class="anchor"></a><code><span><span class="keyword">val</span> pp_meth : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-string_of_meth" class="anchored"><a href="#val-string_of_meth" class="anchor"></a><code><span><span class="keyword">val</span> string_of_meth : <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-IO" class="anchored"><a href="#module-type-IO" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span>IO</span><span> = <a href="../../ezcurl/Ezcurl_core/module-type-IO/index.html">Ezcurl_core.IO</a></span></code></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-S" class="anchored"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> </span><span>S</span><span> = <a href="../../ezcurl/Ezcurl_core/module-type-S/index.html">Ezcurl_core.S</a></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Make" class="anchored"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>Make</span><span> = <a href="../../ezcurl/Ezcurl_core/Make/index.html">Ezcurl_core.Make</a></span></code></div></div></details></div><div class="odoc-spec"><div class="spec type" id="type-io" class="anchored"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span><span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-http" class="anchored"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../../ezcurl/Ezcurl_core/index.html#type-t">Ezcurl_core.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../../ezcurl/Ezcurl_core/Config/index.html#type-t">Ezcurl_core.Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>meth:<a href="../../ezcurl/Ezcurl_core/index.html#type-meth">Ezcurl_core.meth</a> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../../ezcurl/Ezcurl_core/index.html#type-response">Ezcurl_core.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><div class="odoc-spec"><div class="spec value" id="val-get" class="anchored"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../../ezcurl/Ezcurl_core/index.html#type-t">Ezcurl_core.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../../ezcurl/Ezcurl_core/Config/index.html#type-t">Ezcurl_core.Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?range:string <span class="arrow">&#45;&gt;</span></span>
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../../ezcurl/Ezcurl_core/index.html#type-response">Ezcurl_core.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><div class="odoc-spec"><div class="spec value" id="val-put" class="anchored"><a href="#val-put" class="anchor"></a><code><span><span class="keyword">val</span> put : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../../ezcurl/Ezcurl_core/index.html#type-t">Ezcurl_core.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../../ezcurl/Ezcurl_core/Config/index.html#type-t">Ezcurl_core.Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>url:string <span class="arrow">&#45;&gt;</span></span> <span>content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../../ezcurl/Ezcurl_core/index.html#type-response">Ezcurl_core.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><div class="odoc-spec"><div class="spec value" id="val-post" class="anchored"><a href="#val-post" class="anchor"></a><code><span><span class="keyword">val</span> post : <span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../../ezcurl/Ezcurl_core/index.html#type-t">Ezcurl_core.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../../ezcurl/Ezcurl_core/Config/index.html#type-t">Ezcurl_core.Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?content:<span>[ <span>`String of string</span> <span><span>| `Write</span> of <span>bytes <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> int</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span>params:<span><span class="xref-unresolved">Curl</span>.curlHTTPPost list</span> <span class="arrow">&#45;&gt;</span></span> <span>url:string <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<a href="../../ezcurl/Ezcurl_core/index.html#type-response">Ezcurl_core.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></div></body></html>
Reference in a new issue View git blame Copy permalink