simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-09 04:17:56 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-opentelemetry/cohttp/Cohttp/Response/Make/argument-1-IO/index.html
c-cube 8e0c79ed41 deploy: 46d1289d95
2025-07-23 14:08:20 +00:00

5 lines
6.4 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>IO (cohttp.Cohttp.Response.Make.IO)</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> &#x00BB; <a href="../../../../index.html">cohttp</a> &#x00BB; <a href="../../../index.html">Cohttp</a> &#x00BB; <a href="../../index.html">Response</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.IO</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> <span>+'a t</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-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</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 &gt;&gt;= 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">&#45;&gt;</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-refill"><a href="#val-refill" class="anchor"></a><code><span><span class="keyword">val</span> refill : <span><a href="#type-ic">ic</a> <span class="arrow">&#45;&gt;</span></span> <span><span>[ `Ok <span>| `Eof</span> ]</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_input_buffer"><a href="#val-with_input_buffer" class="anchor"></a><code><span><span class="keyword">val</span> with_input_buffer :
<span><a href="#type-ic">ic</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">f</span>:<span>(<span>string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">pos</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">len</span>:int <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> * int)</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></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">&#45;&gt;</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">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</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">&#45;&gt;</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></div></body></html>
Reference in a new issue View git blame Copy permalink