mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
2 lines
7.4 KiB
HTML
2 lines
7.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (cohttp-lwt.Cohttp_lwt.Make_client.IO)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</a> » <a href="../../../index.html">cohttp-lwt</a> » <a href="../../index.html">Cohttp_lwt</a> » <a href="../index.html">Make_client</a> » IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make_client.IO</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> <a href="../../../../cohttp/Cohttp/S/module-type-IO/index.html">Cohttp.S.IO</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="../../../../cohttp/Cohttp/S/module-type-IO/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <a href="../../../../lwt/Lwt/index.html#type-t">Lwt.t</a></span></span></span></code></summary><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> <span>'a t</span></span><span> = <span><span class="type-var">'a</span> <a href="../../../../lwt/Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>'a t</code> represents a blocking monad state</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>>=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>a >>= b</code> will pass the result of <code>a</code> to the <code>b</code> function. This is a monadic <code>bind</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>return a</code> will construct a constant IO value.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-ic"><a href="#type-ic" class="anchor"></a><code><span><span class="keyword">type</span> ic</span></code></div><div class="spec-doc"><p><code>ic</code> represents an input channel</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-oc"><a href="#type-oc" class="anchor"></a><code><span><span class="keyword">type</span> oc</span></code></div><div class="spec-doc"><p><code>oc</code> represents an output channel</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-conn"><a href="#type-conn" class="anchor"></a><code><span><span class="keyword">type</span> conn</span></code></div><div class="spec-doc"><p><code>conn</code> represents the underlying network flow</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read_line"><a href="#val-read_line" class="anchor"></a><code><span><span class="keyword">val</span> read_line : <span><a href="#type-ic">ic</a> <span class="arrow">-></span></span> <span><span>string option</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>read_line ic</code> will read a single line terminated by CR or CRLF from the input channel <code>ic</code>. It returns <code>None</code> if EOF or other error condition is reached.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="#type-ic">ic</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>string <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>read ic len</code> will block until a maximum of <code>len</code> characters are read from the input channel <code>ic</code>. It returns an empty string if EOF or some other error condition occurs on the input channel, and can also return fewer than <code>len</code> characters if input buffering is not sufficient to satisfy the request.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="#type-oc">oc</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>write oc s</code> will block until the complete <code>s</code> string is written to the output channel <code>oc</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flush"><a href="#val-flush" class="anchor"></a><code><span><span class="keyword">val</span> flush : <span><a href="#type-oc">oc</a> <span class="arrow">-></span></span> <span>unit <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>flush oc</code> will return when all previously buffered content from calling <a href="#val-write"><code>write</code></a> have been written to the output channel <code>oc</code>.</p></div></div></details></div><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-catch"><a href="#val-catch" class="anchor"></a><code><span><span class="keyword">val</span> catch : <span><span>(<span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="#type-error">error</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>catch f</code> is <code>f () >|= Result.ok</code>, unless <code>f</code> fails with an IO error, in which case it returns the error.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_error"><a href="#val-pp_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_error : <span><a href="../../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-error">error</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|