mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
3 lines
No EOL
3.6 KiB
HTML
3 lines
No EOL
3.6 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCRingBuffer (containers.CCRingBuffer)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCRingBuffer</span></h1></header><h2>Circular Buffer (Deque)</h2><p>Useful for IO, or as a bounded-size alternative to Queue when
|
|
batch operations are needed.</p><p><b>status: experimental</b></p><p>Change in the API to provide only a bounded buffer since 1.3</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.9</li></ul><h3>Underlying Array</h3><div class="spec module" id="module-Array"><a href="#module-Array" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Array/index.html">Array</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"><p>The abstract type for arrays</p></div></div><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><div class="def module-type"><code><span class="keyword">module type </span><a href="module-type-S/index.html">S</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"><h3>Ring Buffer</h3></div></div><div class="spec module" id="module-Byte"><a href="#module-Byte" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Byte/index.html">Byte</a> : <a href="index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">module </span><a href="module-type-S/Array/index.html">Array</a> = <a href="Array/index.html#module-Byte">Array.Byte</a></code></div><div class="doc"><p>An efficient byte based ring buffer</p></div></div><div class="spec module" id="module-MakeFromArray"><a href="#module-MakeFromArray" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="MakeFromArray/index.html">MakeFromArray</a> : <span class="keyword">functor</span> (<a href="MakeFromArray/argument-1-A/index.html">A</a> : <a href="Array/index.html#module-type-S">Array.S</a>) -> <a href="index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">module </span><a href="MakeFromArray/Array/index.html">Array</a> = <a href="MakeFromArray/index.html#argument-1-A">A</a></code></div><div class="doc"><p>Makes a ring buffer module with the given array type</p></div></div><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) -> <a href="index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">type </span><a href="Make/Array/index.html#type-elt">Array.elt</a><span class="keyword"> = </span><a href="Make/argument-1-X/index.html#type-t">X.t</a><span class="keyword"> and </span><span class="keyword">type </span><a href="Make/Array/index.html#type-t">Array.t</a><span class="keyword"> = </span><a href="Make/argument-1-X/index.html#type-t">X.t</a> array</code></div><div class="doc"><p>Buffer using regular arrays</p></div></div></body></html> |