mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
7 lines
8.4 KiB
HTML
7 lines
8.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Request (http.Http.Request)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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">Index</a> » <a href="../../index.html">http</a> » <a href="../index.html">Http</a> » Request</nav><header class="odoc-preamble"><h1>Module <code><span>Http.Request</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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.headers" class="def record field anchored"><a href="#type-t.headers" class="anchor"></a><code><span>headers : <a href="../Header/index.html#type-t">Header.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>HTTP request headers</p><span class="comment-delim">*)</span></div></li><li id="type-t.meth" class="def record field anchored"><a href="#type-t.meth" class="anchor"></a><code><span>meth : <a href="../Method/index.html#type-t">Method.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>HTTP request method</p><span class="comment-delim">*)</span></div></li><li id="type-t.resource" class="def record field anchored"><a href="#type-t.resource" class="anchor"></a><code><span>resource : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Request path and query</p><span class="comment-delim">*)</span></div></li><li id="type-t.version" class="def record field anchored"><a href="#type-t.version" class="anchor"></a><code><span>version : <a href="../Version/index.html#type-t">Version.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>HTTP version, usually 1.1</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-has_body"><a href="#val-has_body" class="anchor"></a><code><span><span class="keyword">val</span> has_body : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>[ `No <span>| `Unknown</span> <span>| `Yes</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-headers"><a href="#val-headers" class="anchor"></a><code><span><span class="keyword">val</span> headers : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Header/index.html#type-t">Header.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-meth"><a href="#val-meth" class="anchor"></a><code><span><span class="keyword">val</span> meth : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Method/index.html#type-t">Method.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource"><a href="#val-resource" class="anchor"></a><code><span><span class="keyword">val</span> resource : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-version"><a href="#val-version" class="anchor"></a><code><span><span class="keyword">val</span> version : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Version/index.html#type-t">Version.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_keep_alive"><a href="#val-is_keep_alive" class="anchor"></a><code><span><span class="keyword">val</span> is_keep_alive : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Return true whether the connection should be reused</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-requires_content_length"><a href="#val-requires_content_length" class="anchor"></a><code><span><span class="keyword">val</span> requires_content_length : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>requires_content_length t</code> is <code>true</code> if <code>t.meth</code> is one of <code>`POST, `PUT or `PATCH</code>. Otherwise it is <code>false</code>.</p><p>A <code>true</code> value indicates that a request must include a "Content-Length" header.</p><p>See https://www.rfc-editor.org/rfc/rfc7230#section-3.3.2</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-content_length"><a href="#val-content_length" class="anchor"></a><code><span><span class="keyword">val</span> content_length : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int option</span></span></code></div><div class="spec-doc"><p><code>content_length t</code> is <code>Some x</code> if the "Content-Length" header in <code>t</code> exists and its value <code>x</code> is a non negative integer, <code>x>=0</code></p><p>It is <code>None</code> if <code>requires_content_length t = false</code> or the value encoded in "Content-Length" is not a valid integer value, i.e <code>>= 0</code>.</p><p>See https://www.rfc-editor.org/rfc/rfc7230#section-3.3.2</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-supports_chunked_trailers"><a href="#val-supports_chunked_trailers" class="anchor"></a><code><span><span class="keyword">val</span> supports_chunked_trailers : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>supports_chunked_trailers t</code> is <code>true</code> if <code>t</code> contains HTTP header "TE: trailers". Otherwise it is <code>false</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_te_trailers"><a href="#val-add_te_trailers" class="anchor"></a><code><span><span class="keyword">val</span> add_te_trailers : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>add_te_trailers t</code> adds HTTP headers, 'TE' and 'Connection' to indicate that a user-agent can handle HTTP chunked trailers headers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||
<span><span class="optlabel">?meth</span>:<a href="../Method/index.html#type-t">Method.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?version</span>:<a href="../Version/index.html#type-t">Version.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?headers</span>:<a href="../Header/index.html#type-t">Header.t</a> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>make resource</code> is a value of <a href="#type-t"><code>t</code></a>. The default values for the response, if not specified, are as follows: <code>meth</code> is <code>`GET</code>, <code>version</code> is <code>`HTTP_1_1</code>, <code>headers</code> is <code>Header.empty</code>. The request encoding value is determined via the <code>Header.get_transfer_encoding</code> function.</p></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><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|