mirror of
https://github.com/c-cube/tiny_httpd.git
synced 2025-12-06 11:15:35 -05:00
2 lines
4.6 KiB
HTML
2 lines
4.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Slice (iostream.Iostream.Slice)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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> » <a href="../index.html">Iostream</a> » Slice</nav><header class="odoc-preamble"><h1>Module <code><span>Iostream.Slice</span></code></h1><p>Byte slice or buffer.</p></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> = <a href="../../Iostream_types/Slice/index.html#type-t">Iostream_types.Slice.t</a></span><span> = </span><span>{</span></code><ol><li id="type-t.bytes" class="def record field anchored"><a href="#type-t.bytes" class="anchor"></a><code><span>bytes : bytes;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Bytes</p><span class="comment-delim">*)</span></div></li><li id="type-t.off" class="def record field anchored"><a href="#type-t.off" class="anchor"></a><code><span><span class="keyword">mutable</span> off : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Offset in bytes</p><span class="comment-delim">*)</span></div></li><li id="type-t.len" class="def record field anchored"><a href="#type-t.len" class="anchor"></a><code><span><span class="keyword">mutable</span> len : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Length of the slice. Empty slice has <code>len=0</code></p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A slice of bytes. The valid bytes in the slice are <code>bytes[off], bytes[off+1], …, bytes[off+len-1]</code> (i.e <code>len</code> bytes starting at offset <code>off</code>).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_bytes"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bytes"><a href="#val-bytes" class="anchor"></a><code><span><span class="keyword">val</span> bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-off"><a href="#val-off" class="anchor"></a><code><span><span class="keyword">val</span> off : <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-len"><a href="#val-len" class="anchor"></a><code><span><span class="keyword">val</span> len : <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-consume"><a href="#val-consume" class="anchor"></a><code><span><span class="keyword">val</span> consume : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Consume the first <code>n</code> bytes from the slice, making it <code>n</code> bytes shorter. This modifies the slice in place.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_index_exn"><a href="#val-find_index_exn" class="anchor"></a><code><span><span class="keyword">val</span> find_index_exn : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>char <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>find index of <code>c</code> in slice, or raise <code>Not_found</code></p></div></div></div></body></html>
|