tiny_httpd/iostream/Iostream/In_buf/class-bufferized/index.html
2024-06-18 20:31:56 +00:00

2 lines
2 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>bufferized (iostream.Iostream.In_buf.bufferized)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">iostream</a> &#x00BB; <a href="../../index.html">Iostream</a> &#x00BB; <a href="../index.html">In_buf</a> &#x00BB; bufferized</nav><header class="odoc-preamble"><h1>Class <code><span>In_buf.bufferized</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec inherit"><code><span><span class="keyword">inherit</span> <span class="xref-unresolved">Iostream__.In.t</span></span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-fill_buf"><a href="#method-fill_buf" class="anchor"></a><code><span><span class="keyword">method</span> fill_buf : <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Iostream__.Slice.t</span></span></code></div><div class="spec-doc"><p><code>ic#fill_buf()</code> returns a slice into the <code>ic</code>'s internal buffer, and ensures it's empty only if <code>ic.ic</code> is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-consume"><a href="#method-consume" class="anchor"></a><code><span><span class="keyword">method</span> consume : <span>int <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Consume <code>n</code> bytes from the inner buffer. This is only valid if the last call to <code>fill_buf</code> returned a slice with at least <code>n</code> bytes.</p></div></div></div></body></html>