ezcurl/dev/ezcurl/Ezcurl_core/index.html
2019-09-14 12:40:45 -05:00

2 lines
No EOL
8.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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_core (ezcurl.Ezcurl_core)</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> &#x00BB; Ezcurl_core</nav><h1>Module <code>Ezcurl_core</code></h1><h2 id="core-signatures-and-implementation"><a href="#core-signatures-and-implementation" class="anchor"></a>Core signatures and implementation</h2></header><div class="spec module" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span class="keyword">module</span> <a href="Config/index.html">Config</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = Curl.t</code></dt></dl><dl><dt class="spec value" id="val-make"><a href="#val-make" class="anchor"></a><code><span class="keyword">val</span> make : ?&#8288;set_opts:(<a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit) <span>&#45;&gt;</span> unit <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-delete"><a href="#val-delete" class="anchor"></a><code><span class="keyword">val</span> delete : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-with_client"><a href="#val-with_client" class="anchor"></a><code><span class="keyword">val</span> with_client : ?&#8288;set_opts:(<a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit) <span>&#45;&gt;</span> (<a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span>) <span>&#45;&gt;</span> <span class="type-var">'a</span></code></dt><dd><p>Make a temporary client, call the function with it, then cleanup</p></dd></dl><dl><dt class="spec type" id="type-response_info"><a href="#type-response_info" class="anchor"></a><code><span class="keyword">type</span> response_info</code><code> = </code><code>{</code><table class="record"><tr id="type-response_info.ri_response_time" class="anchored"><td class="def field"><a href="#type-response_info.ri_response_time" class="anchor"></a><code>ri_response_time : float;</code></td></tr><tr id="type-response_info.ri_redirect_count" class="anchored"><td class="def field"><a href="#type-response_info.ri_redirect_count" class="anchor"></a><code>ri_redirect_count : int;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-pp_response_info"><a href="#val-pp_response_info" class="anchor"></a><code><span class="keyword">val</span> pp_response_info : Format.formatter <span>&#45;&gt;</span> <a href="index.html#type-response_info">response_info</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-string_of_response_info"><a href="#val-string_of_response_info" class="anchor"></a><code><span class="keyword">val</span> string_of_response_info : <a href="index.html#type-response_info">response_info</a> <span>&#45;&gt;</span> string</code></dt></dl><dl><dt class="spec type" id="type-response"><a href="#type-response" class="anchor"></a><code><span class="keyword">type</span> response</code><code> = </code><code>{</code><table class="record"><tr id="type-response.code" class="anchored"><td class="def field"><a href="#type-response.code" class="anchor"></a><code>code : int;</code></td></tr><tr id="type-response.headers" class="anchored"><td class="def field"><a href="#type-response.headers" class="anchor"></a><code>headers : (string * string) list;</code></td></tr><tr id="type-response.body" class="anchored"><td class="def field"><a href="#type-response.body" class="anchor"></a><code>body : string;</code></td></tr><tr id="type-response.info" class="anchored"><td class="def field"><a href="#type-response.info" class="anchor"></a><code>info : <a href="index.html#type-response_info">response_info</a>;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-pp_response"><a href="#val-pp_response" class="anchor"></a><code><span class="keyword">val</span> pp_response : Format.formatter <span>&#45;&gt;</span> <a href="index.html#type-response">response</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-string_of_response"><a href="#val-string_of_response" class="anchor"></a><code><span class="keyword">val</span> string_of_response : <a href="index.html#type-response">response</a> <span>&#45;&gt;</span> string</code></dt></dl><dl><dt class="spec type" id="type-meth"><a href="#type-meth" class="anchor"></a><code><span class="keyword">type</span> meth</code><code> = </code><table class="variant"><tr id="type-meth.GET" class="anchored"><td class="def constructor"><a href="#type-meth.GET" class="anchor"></a><code>| </code><code><span class="constructor">GET</span></code></td></tr><tr id="type-meth.POST" class="anchored"><td class="def constructor"><a href="#type-meth.POST" class="anchor"></a><code>| </code><code><span class="constructor">POST</span> <span class="keyword">of</span> Curl.curlHTTPPost list</code></td></tr><tr id="type-meth.PUT" class="anchored"><td class="def constructor"><a href="#type-meth.PUT" class="anchor"></a><code>| </code><code><span class="constructor">PUT</span></code></td></tr><tr id="type-meth.DELETE" class="anchored"><td class="def constructor"><a href="#type-meth.DELETE" class="anchor"></a><code>| </code><code><span class="constructor">DELETE</span></code></td></tr><tr id="type-meth.HEAD" class="anchored"><td class="def constructor"><a href="#type-meth.HEAD" class="anchor"></a><code>| </code><code><span class="constructor">HEAD</span></code></td></tr><tr id="type-meth.CONNECT" class="anchored"><td class="def constructor"><a href="#type-meth.CONNECT" class="anchor"></a><code>| </code><code><span class="constructor">CONNECT</span></code></td></tr><tr id="type-meth.OPTIONS" class="anchored"><td class="def constructor"><a href="#type-meth.OPTIONS" class="anchor"></a><code>| </code><code><span class="constructor">OPTIONS</span></code></td></tr><tr id="type-meth.TRACE" class="anchored"><td class="def constructor"><a href="#type-meth.TRACE" class="anchor"></a><code>| </code><code><span class="constructor">TRACE</span></code></td></tr><tr id="type-meth.PATCH" class="anchored"><td class="def constructor"><a href="#type-meth.PATCH" class="anchor"></a><code>| </code><code><span class="constructor">PATCH</span></code></td></tr></table></dt><dd><p>The <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods">HTTP method</a> to use</p></dd></dl><dl><dt class="spec value" id="val-pp_meth"><a href="#val-pp_meth" class="anchor"></a><code><span class="keyword">val</span> pp_meth : Format.formatter <span>&#45;&gt;</span> <a href="index.html#type-meth">meth</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-string_of_meth"><a href="#val-string_of_meth" class="anchor"></a><code><span class="keyword">val</span> string_of_meth : <a href="index.html#type-meth">meth</a> <span>&#45;&gt;</span> string</code></dt></dl><dl><dt class="spec module-type" id="module-type-IO"><a href="#module-type-IO" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-IO/index.html">IO</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> <a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-IO/index.html">IO</a> : <a href="index.html#module-type-IO">IO</a>) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> 'a <a href="Make/index.html#type-io">io</a> = <span class="type-var">'a</span> <a href="Make/argument-1-IO/index.html#type-t">IO.t</a></code></div></div></body></html>