simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-09 12:23:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-opentelemetry/cohttp/Cohttp/Code/index.html
c-cube 0e6d3babb5 deploy: 4f9247d6d0
2025-01-31 01:39:34 +00:00

2 lines
50 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>Code (cohttp.Cohttp.Code)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">cohttp</a> &#x00BB; <a href="../index.html">Cohttp</a> &#x00BB; Code</nav><header class="odoc-preamble"><h1>Module <code><span>Cohttp.Code</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-version"><a href="#type-version" class="anchor"></a><code><span><span class="keyword">type</span> version</span><span> = </span><span>[ </span></code><ol><li id="type-version.HTTP_1_0" class="def variant constructor anchored"><a href="#type-version.HTTP_1_0" class="anchor"></a><code><span>| </span><span>`HTTP_1_0</span></code></li><li id="type-version.HTTP_1_1" class="def variant constructor anchored"><a href="#type-version.HTTP_1_1" class="anchor"></a><code><span>| </span><span>`HTTP_1_1</span></code></li><li id="type-version.Other" class="def variant constructor anchored"><a href="#type-version.Other" class="anchor"></a><code><span>| </span><span>`Other <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_version"><a href="#val-sexp_of_version" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_version : <span><a href="#type-version">version</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-version_of_sexp"><a href="#val-version_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> version_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-version">version</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__version_of_sexp__"><a href="#val-__version_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __version_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-version">version</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-meth"><a href="#type-meth" class="anchor"></a><code><span><span class="keyword">type</span> meth</span><span> = </span><span>[ </span></code><ol><li id="type-meth.GET" class="def variant constructor anchored"><a href="#type-meth.GET" class="anchor"></a><code><span>| </span><span>`GET</span></code></li><li id="type-meth.POST" class="def variant constructor anchored"><a href="#type-meth.POST" class="anchor"></a><code><span>| </span><span>`POST</span></code></li><li id="type-meth.HEAD" class="def variant constructor anchored"><a href="#type-meth.HEAD" class="anchor"></a><code><span>| </span><span>`HEAD</span></code></li><li id="type-meth.DELETE" class="def variant constructor anchored"><a href="#type-meth.DELETE" class="anchor"></a><code><span>| </span><span>`DELETE</span></code></li><li id="type-meth.PATCH" class="def variant constructor anchored"><a href="#type-meth.PATCH" class="anchor"></a><code><span>| </span><span>`PATCH</span></code></li><li id="type-meth.PUT" class="def variant constructor anchored"><a href="#type-meth.PUT" class="anchor"></a><code><span>| </span><span>`PUT</span></code></li><li id="type-meth.OPTIONS" class="def variant constructor anchored"><a href="#type-meth.OPTIONS" class="anchor"></a><code><span>| </span><span>`OPTIONS</span></code></li><li id="type-meth.TRACE" class="def variant constructor anchored"><a href="#type-meth.TRACE" class="anchor"></a><code><span>| </span><span>`TRACE</span></code></li><li id="type-meth.CONNECT" class="def variant constructor anchored"><a href="#type-meth.CONNECT" class="anchor"></a><code><span>| </span><span>`CONNECT</span></code></li><li id="type-meth.Other" class="def variant constructor anchored"><a href="#type-meth.Other" class="anchor"></a><code><span>| </span><span>`Other <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_meth"><a href="#val-sexp_of_meth" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_meth : <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-meth_of_sexp"><a href="#val-meth_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> meth_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-meth">meth</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__meth_of_sexp__"><a href="#val-__meth_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __meth_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-meth">meth</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-informational_status"><a href="#type-informational_status" class="anchor"></a><code><span><span class="keyword">type</span> informational_status</span><span> = </span><span>[ </span></code><ol><li id="type-informational_status.Continue" class="def variant constructor anchored"><a href="#type-informational_status.Continue" class="anchor"></a><code><span>| </span><span>`Continue</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Client should continue with request</p><span class="comment-delim">*)</span></div></li><li id="type-informational_status.Switching_protocols" class="def variant constructor anchored"><a href="#type-informational_status.Switching_protocols" class="anchor"></a><code><span>| </span><span>`Switching_protocols</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Server is switching protocols</p><span class="comment-delim">*)</span></div></li><li id="type-informational_status.Processing" class="def variant constructor anchored"><a href="#type-informational_status.Processing" class="anchor"></a><code><span>| </span><span>`Processing</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Server has received and is processing the request</p><span class="comment-delim">*)</span></div></li><li id="type-informational_status.Checkpoint" class="def variant constructor anchored"><a href="#type-informational_status.Checkpoint" class="anchor"></a><code><span>| </span><span>`Checkpoint</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>resume aborted PUT or POST requests</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Informational</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_informational_status"><a href="#val-sexp_of_informational_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_informational_status : <span><a href="#type-informational_status">informational_status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-informational_status_of_sexp"><a href="#val-informational_status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> informational_status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-informational_status">informational_status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__informational_status_of_sexp__"><a href="#val-__informational_status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __informational_status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-informational_status">informational_status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-success_status"><a href="#type-success_status" class="anchor"></a><code><span><span class="keyword">type</span> success_status</span><span> = </span><span>[ </span></code><ol><li id="type-success_status.OK" class="def variant constructor anchored"><a href="#type-success_status.OK" class="anchor"></a><code><span>| </span><span>`OK</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>standard response for successful HTTP requests</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Created" class="def variant constructor anchored"><a href="#type-success_status.Created" class="anchor"></a><code><span>| </span><span>`Created</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request has been fulfilled; new resource created</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Accepted" class="def variant constructor anchored"><a href="#type-success_status.Accepted" class="anchor"></a><code><span>| </span><span>`Accepted</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request accepted, processing pending</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Non_authoritative_information" class="def variant constructor anchored"><a href="#type-success_status.Non_authoritative_information" class="anchor"></a><code><span>| </span><span>`Non_authoritative_information</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request processed, information may be from another source</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.No_content" class="def variant constructor anchored"><a href="#type-success_status.No_content" class="anchor"></a><code><span>| </span><span>`No_content</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request processed, no content returned</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Reset_content" class="def variant constructor anchored"><a href="#type-success_status.Reset_content" class="anchor"></a><code><span>| </span><span>`Reset_content</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request processed, no content returned, reset document view</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Partial_content" class="def variant constructor anchored"><a href="#type-success_status.Partial_content" class="anchor"></a><code><span>| </span><span>`Partial_content</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>partial resource return due to request header</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Multi_status" class="def variant constructor anchored"><a href="#type-success_status.Multi_status" class="anchor"></a><code><span>| </span><span>`Multi_status</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>XML, can contain multiple separate responses</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Already_reported" class="def variant constructor anchored"><a href="#type-success_status.Already_reported" class="anchor"></a><code><span>| </span><span>`Already_reported</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>results previously returned</p><span class="comment-delim">*)</span></div></li><li id="type-success_status.Im_used" class="def variant constructor anchored"><a href="#type-success_status.Im_used" class="anchor"></a><code><span>| </span><span>`Im_used</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request fulfilled, reponse is instance-manipulations</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Success</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_success_status"><a href="#val-sexp_of_success_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_success_status : <span><a href="#type-success_status">success_status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-success_status_of_sexp"><a href="#val-success_status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> success_status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-success_status">success_status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__success_status_of_sexp__"><a href="#val-__success_status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __success_status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-success_status">success_status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-redirection_status"><a href="#type-redirection_status" class="anchor"></a><code><span><span class="keyword">type</span> redirection_status</span><span> = </span><span>[ </span></code><ol><li id="type-redirection_status.Multiple_choices" class="def variant constructor anchored"><a href="#type-redirection_status.Multiple_choices" class="anchor"></a><code><span>| </span><span>`Multiple_choices</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>multiple options for the resource delivered</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Moved_permanently" class="def variant constructor anchored"><a href="#type-redirection_status.Moved_permanently" class="anchor"></a><code><span>| </span><span>`Moved_permanently</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>this and all future requests directed to the given URI</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Found" class="def variant constructor anchored"><a href="#type-redirection_status.Found" class="anchor"></a><code><span>| </span><span>`Found</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>temporary response to request found via alternative URI</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.See_other" class="def variant constructor anchored"><a href="#type-redirection_status.See_other" class="anchor"></a><code><span>| </span><span>`See_other</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>permanent response to request found via alternative URI</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Not_modified" class="def variant constructor anchored"><a href="#type-redirection_status.Not_modified" class="anchor"></a><code><span>| </span><span>`Not_modified</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>resource has not been modified since last requested</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Use_proxy" class="def variant constructor anchored"><a href="#type-redirection_status.Use_proxy" class="anchor"></a><code><span>| </span><span>`Use_proxy</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>content located elsewhere, retrieve from there</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Switch_proxy" class="def variant constructor anchored"><a href="#type-redirection_status.Switch_proxy" class="anchor"></a><code><span>| </span><span>`Switch_proxy</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>subsequent requests should use the specified proxy</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Temporary_redirect" class="def variant constructor anchored"><a href="#type-redirection_status.Temporary_redirect" class="anchor"></a><code><span>| </span><span>`Temporary_redirect</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>connect again to different URI as provided</p><span class="comment-delim">*)</span></div></li><li id="type-redirection_status.Permanent_redirect" class="def variant constructor anchored"><a href="#type-redirection_status.Permanent_redirect" class="anchor"></a><code><span>| </span><span>`Permanent_redirect</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>connect again to a different URI using the same method</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Redirection</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_redirection_status"><a href="#val-sexp_of_redirection_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_redirection_status : <span><a href="#type-redirection_status">redirection_status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-redirection_status_of_sexp"><a href="#val-redirection_status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> redirection_status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-redirection_status">redirection_status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__redirection_status_of_sexp__"><a href="#val-__redirection_status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __redirection_status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-redirection_status">redirection_status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-client_error_status"><a href="#type-client_error_status" class="anchor"></a><code><span><span class="keyword">type</span> client_error_status</span><span> = </span><span>[ </span></code><ol><li id="type-client_error_status.Bad_request" class="def variant constructor anchored"><a href="#type-client_error_status.Bad_request" class="anchor"></a><code><span>| </span><span>`Bad_request</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request cannot be fulfilled due to bad syntax</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Unauthorized" class="def variant constructor anchored"><a href="#type-client_error_status.Unauthorized" class="anchor"></a><code><span>| </span><span>`Unauthorized</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>authentication is possible but has failed</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Payment_required" class="def variant constructor anchored"><a href="#type-client_error_status.Payment_required" class="anchor"></a><code><span>| </span><span>`Payment_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>payment required, reserved for future use</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Forbidden" class="def variant constructor anchored"><a href="#type-client_error_status.Forbidden" class="anchor"></a><code><span>| </span><span>`Forbidden</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server refuses to respond to request</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Not_found" class="def variant constructor anchored"><a href="#type-client_error_status.Not_found" class="anchor"></a><code><span>| </span><span>`Not_found</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>requested resource could not be found</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Method_not_allowed" class="def variant constructor anchored"><a href="#type-client_error_status.Method_not_allowed" class="anchor"></a><code><span>| </span><span>`Method_not_allowed</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request method not supported by that resource</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Not_acceptable" class="def variant constructor anchored"><a href="#type-client_error_status.Not_acceptable" class="anchor"></a><code><span>| </span><span>`Not_acceptable</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>content not acceptable according to the Accept headers</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Proxy_authentication_required" class="def variant constructor anchored"><a href="#type-client_error_status.Proxy_authentication_required" class="anchor"></a><code><span>| </span><span>`Proxy_authentication_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>client must first authenticate itself with the proxy</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Request_timeout" class="def variant constructor anchored"><a href="#type-client_error_status.Request_timeout" class="anchor"></a><code><span>| </span><span>`Request_timeout</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server timed out waiting for the request</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Conflict" class="def variant constructor anchored"><a href="#type-client_error_status.Conflict" class="anchor"></a><code><span>| </span><span>`Conflict</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request could not be processed because of conflict</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Gone" class="def variant constructor anchored"><a href="#type-client_error_status.Gone" class="anchor"></a><code><span>| </span><span>`Gone</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>resource is no longer available and will not be available again</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Length_required" class="def variant constructor anchored"><a href="#type-client_error_status.Length_required" class="anchor"></a><code><span>| </span><span>`Length_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request did not specify the length of its content</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Precondition_failed" class="def variant constructor anchored"><a href="#type-client_error_status.Precondition_failed" class="anchor"></a><code><span>| </span><span>`Precondition_failed</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server does not meet request preconditions</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Request_entity_too_large" class="def variant constructor anchored"><a href="#type-client_error_status.Request_entity_too_large" class="anchor"></a><code><span>| </span><span>`Request_entity_too_large</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request is larger than the server is willing or able to process</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Request_uri_too_long" class="def variant constructor anchored"><a href="#type-client_error_status.Request_uri_too_long" class="anchor"></a><code><span>| </span><span>`Request_uri_too_long</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>URI provided was too long for the server to process</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Unsupported_media_type" class="def variant constructor anchored"><a href="#type-client_error_status.Unsupported_media_type" class="anchor"></a><code><span>| </span><span>`Unsupported_media_type</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server does not support media type</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Requested_range_not_satisfiable" class="def variant constructor anchored"><a href="#type-client_error_status.Requested_range_not_satisfiable" class="anchor"></a><code><span>| </span><span>`Requested_range_not_satisfiable</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>client has asked for unprovidable portion of the file</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Expectation_failed" class="def variant constructor anchored"><a href="#type-client_error_status.Expectation_failed" class="anchor"></a><code><span>| </span><span>`Expectation_failed</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server cannot meet requirements of Expect request-header field</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.I_m_a_teapot" class="def variant constructor anchored"><a href="#type-client_error_status.I_m_a_teapot" class="anchor"></a><code><span>| </span><span>`I_m_a_teapot</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>I'm a teapot</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Enhance_your_calm" class="def variant constructor anchored"><a href="#type-client_error_status.Enhance_your_calm" class="anchor"></a><code><span>| </span><span>`Enhance_your_calm</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Twitter rate limiting</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Unprocessable_entity" class="def variant constructor anchored"><a href="#type-client_error_status.Unprocessable_entity" class="anchor"></a><code><span>| </span><span>`Unprocessable_entity</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request unable to be followed due to semantic errors</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Locked" class="def variant constructor anchored"><a href="#type-client_error_status.Locked" class="anchor"></a><code><span>| </span><span>`Locked</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>resource that is being accessed is locked</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Failed_dependency" class="def variant constructor anchored"><a href="#type-client_error_status.Failed_dependency" class="anchor"></a><code><span>| </span><span>`Failed_dependency</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request failed due to failure of a previous request</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Upgrade_required" class="def variant constructor anchored"><a href="#type-client_error_status.Upgrade_required" class="anchor"></a><code><span>| </span><span>`Upgrade_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>client should switch to a different protocol</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Precondition_required" class="def variant constructor anchored"><a href="#type-client_error_status.Precondition_required" class="anchor"></a><code><span>| </span><span>`Precondition_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>origin server requires the request to be conditional</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Too_many_requests" class="def variant constructor anchored"><a href="#type-client_error_status.Too_many_requests" class="anchor"></a><code><span>| </span><span>`Too_many_requests</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>user has sent too many requests in a given amount of time</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Request_header_fields_too_large" class="def variant constructor anchored"><a href="#type-client_error_status.Request_header_fields_too_large" class="anchor"></a><code><span>| </span><span>`Request_header_fields_too_large</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server is unwilling to process the request</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.No_response" class="def variant constructor anchored"><a href="#type-client_error_status.No_response" class="anchor"></a><code><span>| </span><span>`No_response</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server returns no information and closes the connection</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Retry_with" class="def variant constructor anchored"><a href="#type-client_error_status.Retry_with" class="anchor"></a><code><span>| </span><span>`Retry_with</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>request should be retried after performing action</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Blocked_by_windows_parental_controls" class="def variant constructor anchored"><a href="#type-client_error_status.Blocked_by_windows_parental_controls" class="anchor"></a><code><span>| </span><span>`Blocked_by_windows_parental_controls</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Windows Parental Controls blocking access to webpage</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Wrong_exchange_server" class="def variant constructor anchored"><a href="#type-client_error_status.Wrong_exchange_server" class="anchor"></a><code><span>| </span><span>`Wrong_exchange_server</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the server cannot reach the client's mailbox</p><span class="comment-delim">*)</span></div></li><li id="type-client_error_status.Client_closed_request" class="def variant constructor anchored"><a href="#type-client_error_status.Client_closed_request" class="anchor"></a><code><span>| </span><span>`Client_closed_request</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>connection closed by client while HTTP server is processing</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Client_error</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_client_error_status"><a href="#val-sexp_of_client_error_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_client_error_status : <span><a href="#type-client_error_status">client_error_status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-client_error_status_of_sexp"><a href="#val-client_error_status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> client_error_status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-client_error_status">client_error_status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__client_error_status_of_sexp__"><a href="#val-__client_error_status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __client_error_status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-client_error_status">client_error_status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-server_error_status"><a href="#type-server_error_status" class="anchor"></a><code><span><span class="keyword">type</span> server_error_status</span><span> = </span><span>[ </span></code><ol><li id="type-server_error_status.Internal_server_error" class="def variant constructor anchored"><a href="#type-server_error_status.Internal_server_error" class="anchor"></a><code><span>| </span><span>`Internal_server_error</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>generic error message</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Not_implemented" class="def variant constructor anchored"><a href="#type-server_error_status.Not_implemented" class="anchor"></a><code><span>| </span><span>`Not_implemented</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server does not recognise method or lacks ability to fulfill</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Bad_gateway" class="def variant constructor anchored"><a href="#type-server_error_status.Bad_gateway" class="anchor"></a><code><span>| </span><span>`Bad_gateway</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server received an invalid response from upstream server</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Service_unavailable" class="def variant constructor anchored"><a href="#type-server_error_status.Service_unavailable" class="anchor"></a><code><span>| </span><span>`Service_unavailable</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server is currently unavailable</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Gateway_timeout" class="def variant constructor anchored"><a href="#type-server_error_status.Gateway_timeout" class="anchor"></a><code><span>| </span><span>`Gateway_timeout</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>gateway did not receive response from upstream server</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Http_version_not_supported" class="def variant constructor anchored"><a href="#type-server_error_status.Http_version_not_supported" class="anchor"></a><code><span>| </span><span>`Http_version_not_supported</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server does not support the HTTP protocol version</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Variant_also_negotiates" class="def variant constructor anchored"><a href="#type-server_error_status.Variant_also_negotiates" class="anchor"></a><code><span>| </span><span>`Variant_also_negotiates</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>content negotiation for the request results in a circular reference</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Insufficient_storage" class="def variant constructor anchored"><a href="#type-server_error_status.Insufficient_storage" class="anchor"></a><code><span>| </span><span>`Insufficient_storage</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server is unable to store the representation</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Loop_detected" class="def variant constructor anchored"><a href="#type-server_error_status.Loop_detected" class="anchor"></a><code><span>| </span><span>`Loop_detected</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>server detected an infinite loop while processing the request</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Bandwidth_limit_exceeded" class="def variant constructor anchored"><a href="#type-server_error_status.Bandwidth_limit_exceeded" class="anchor"></a><code><span>| </span><span>`Bandwidth_limit_exceeded</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>bandwidth limit exceeded</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Not_extended" class="def variant constructor anchored"><a href="#type-server_error_status.Not_extended" class="anchor"></a><code><span>| </span><span>`Not_extended</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>further extensions to the request are required</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Network_authentication_required" class="def variant constructor anchored"><a href="#type-server_error_status.Network_authentication_required" class="anchor"></a><code><span>| </span><span>`Network_authentication_required</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>client needs to authenticate to gain network access</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Network_read_timeout_error" class="def variant constructor anchored"><a href="#type-server_error_status.Network_read_timeout_error" class="anchor"></a><code><span>| </span><span>`Network_read_timeout_error</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>network read timeout behind the proxy</p><span class="comment-delim">*)</span></div></li><li id="type-server_error_status.Network_connect_timeout_error" class="def variant constructor anchored"><a href="#type-server_error_status.Network_connect_timeout_error" class="anchor"></a><code><span>| </span><span>`Network_connect_timeout_error</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>network connect timeout behind the proxy</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Server_error</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_server_error_status"><a href="#val-sexp_of_server_error_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_server_error_status : <span><a href="#type-server_error_status">server_error_status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-server_error_status_of_sexp"><a href="#val-server_error_status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> server_error_status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-server_error_status">server_error_status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__server_error_status_of_sexp__"><a href="#val-__server_error_status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __server_error_status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-server_error_status">server_error_status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-status"><a href="#type-status" class="anchor"></a><code><span><span class="keyword">type</span> status</span><span> = </span><span>[ </span></code><ol><li id="type-status.informational_status" class="def variant type anchored"><a href="#type-status.informational_status" class="anchor"></a><code><span>| </span><span><a href="#type-informational_status">informational_status</a></span></code></li><li id="type-status.success_status" class="def variant type anchored"><a href="#type-status.success_status" class="anchor"></a><code><span>| </span><span><a href="#type-success_status">success_status</a></span></code></li><li id="type-status.redirection_status" class="def variant type anchored"><a href="#type-status.redirection_status" class="anchor"></a><code><span>| </span><span><a href="#type-redirection_status">redirection_status</a></span></code></li><li id="type-status.client_error_status" class="def variant type anchored"><a href="#type-status.client_error_status" class="anchor"></a><code><span>| </span><span><a href="#type-client_error_status">client_error_status</a></span></code></li><li id="type-status.server_error_status" class="def variant type anchored"><a href="#type-status.server_error_status" class="anchor"></a><code><span>| </span><span><a href="#type-server_error_status">server_error_status</a></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_status"><a href="#val-sexp_of_status" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_status : <span><a href="#type-status">status</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_of_sexp"><a href="#val-status_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> status_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-status">status</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__status_of_sexp__"><a href="#val-__status_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __status_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-status">status</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-status_code"><a href="#type-status_code" class="anchor"></a><code><span><span class="keyword">type</span> status_code</span><span> = </span><span>[ </span></code><ol><li id="type-status_code.Code" class="def variant constructor anchored"><a href="#type-status_code.Code" class="anchor"></a><code><span>| </span><span>`Code <span class="keyword">of</span> int</span></code></li><li id="type-status_code.status" class="def variant type anchored"><a href="#type-status_code.status" class="anchor"></a><code><span>| </span><span><a href="#type-status">status</a></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_status_code"><a href="#val-sexp_of_status_code" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_status_code : <span><a href="#type-status_code">status_code</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_code_of_sexp"><a href="#val-status_code_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> status_code_of_sexp : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-status_code">status_code</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-__status_code_of_sexp__"><a href="#val-__status_code_of_sexp__" class="anchor"></a><code><span><span class="keyword">val</span> __status_code_of_sexp__ : <span><a href="../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-status_code">status_code</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_version"><a href="#val-string_of_version" class="anchor"></a><code><span><span class="keyword">val</span> string_of_version : <span><a href="#type-version">version</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Convert a version to a string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-version_of_string"><a href="#val-version_of_string" class="anchor"></a><code><span><span class="keyword">val</span> version_of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-version">version</a></span></code></div><div class="spec-doc"><p>Convert a string to a version.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_version"><a href="#val-compare_version" class="anchor"></a><code><span><span class="keyword">val</span> compare_version : <span><a href="#type-version">version</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-version">version</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Comparison function for <code>version</code> values</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_method"><a href="#val-string_of_method" class="anchor"></a><code><span><span class="keyword">val</span> string_of_method : <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Convert a method to a string.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-method_of_string"><a href="#val-method_of_string" class="anchor"></a><code><span><span class="keyword">val</span> method_of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-meth">meth</a></span></code></div><div class="spec-doc"><p>Convert a string to a method.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_method"><a href="#val-compare_method" class="anchor"></a><code><span><span class="keyword">val</span> compare_method : <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-meth">meth</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Comparison function for <code>method</code> values</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-status_of_code"><a href="#val-status_of_code" class="anchor"></a><code><span><span class="keyword">val</span> status_of_code : <span>int <span class="arrow">&#45;&gt;</span></span> <a href="#type-status_code">status_code</a></span></code></div><div class="spec-doc"><p>Generate status values from int codes.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-code_of_status"><a href="#val-code_of_status" class="anchor"></a><code><span><span class="keyword">val</span> code_of_status : <span><a href="#type-status_code">status_code</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Generate an int code from a status value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_status"><a href="#val-string_of_status" class="anchor"></a><code><span><span class="keyword">val</span> string_of_status : <span><a href="#type-status_code">status_code</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Give a description of the given status value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reason_phrase_of_code"><a href="#val-reason_phrase_of_code" class="anchor"></a><code><span><span class="keyword">val</span> reason_phrase_of_code : <span>int <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>Give a description of the given int code.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_informational"><a href="#val-is_informational" class="anchor"></a><code><span><span class="keyword">val</span> is_informational : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Is the given int code belong to the class of &quot;informational&quot; return code ?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_success"><a href="#val-is_success" class="anchor"></a><code><span><span class="keyword">val</span> is_success : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Is the given int code belong to the class of &quot;success&quot; return code ?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_redirection"><a href="#val-is_redirection" class="anchor"></a><code><span><span class="keyword">val</span> is_redirection : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Is the given int code belong to the class of &quot;redirection&quot; return code ?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_client_error"><a href="#val-is_client_error" class="anchor"></a><code><span><span class="keyword">val</span> is_client_error : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Is the given int code belong to the class of &quot;client_error&quot; return code ?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_server_error"><a href="#val-is_server_error" class="anchor"></a><code><span><span class="keyword">val</span> is_server_error : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Is the given int code belong to the class of &quot;server_error&quot; return code ?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_error"><a href="#val-is_error" class="anchor"></a><code><span><span class="keyword">val</span> is_error : <span>int <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Return true for client and server error status codes.</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink