mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
4 lines
No EOL
4 KiB
HTML
4 lines
No EOL
4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCRingBuffer (containers-data.CCRingBuffer)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">containers-data</a> » CCRingBuffer</nav><header class="odoc-preamble"><h1>Module <code><span>CCRingBuffer</span></code></h1><p>Circular Buffer (Deque)</p><p>Useful for IO, or as a bounded-size alternative to <code>Queue</code> 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-tags"><li class="since"><span class="at-tag">since</span> 0.9</li></ul></header><nav class="odoc-toc"><ul><li><a href="#underlying-array">Underlying Array</a></li></ul></nav><div class="odoc-content"><h3 id="underlying-array"><a href="#underlying-array" class="anchor"></a>Underlying Array</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Array"><a href="#module-Array" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Array/index.html">Array</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The abstract type for arrays</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Byte"><a href="#module-Byte" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Byte/index.html">Byte</a></span><span> : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Array/index.html">Array</a> = <a href="Array/Byte/index.html">Array.Byte</a></span></span></code></div><div class="spec-doc"><p>An efficient byte based ring buffer</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-MakeFromArray"><a href="#module-MakeFromArray" class="anchor"></a><code><span><span class="keyword">module</span> <a href="MakeFromArray/index.html">MakeFromArray</a></span><span> (<a href="MakeFromArray/argument-1-A/index.html">A</a> : <a href="Array/module-type-S/index.html">Array.S</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Array/index.html">Array</a> = <a href="MakeFromArray/argument-1-A/index.html">A</a></span></span></code></div><div class="spec-doc"><p>Makes a ring buffer module with the given array type</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
|
||
(<a href="Make/argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) :
|
||
<a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/Array/index.html#type-elt">Array.elt</a> = <a href="Make/argument-1-X/index.html#type-t">X.t</a></span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/Array/index.html#type-t">Array.t</a> = <span><a href="Make/argument-1-X/index.html#type-t">X.t</a> array</span></span></span></code></div><div class="spec-doc"><p>Buffer using regular arrays</p></div></div></div></body></html> |