A persistent collection with semantics roughly equivalent to a ring buffer: acts like a queue, but has a predetermined maximum capacity; items added after that capacity is exceeded implicitly eject items from the front of the queue to make room.
Implements all the relevant Clojure interfaces, but none of the java interop interfaces; pull requests welcome.
Possible optimization: keep a reference to unused items until some new item overwrites it. This is easier and faster, but if you have a queue with very large objects (or a very large, mostly-empty queue), you may see memory leaks. The performance gain is probably not worth it, but I suppose that's a tradeoff some may not be willing to make.
Add the dependency into your
See the ring-buffer Clojars page for Leiningen and Maven install snippets.
Then require the namespace:
(:require [amalloy.ring-buffer :refer :all]))
Finally add and remove items from the ring-buffer
(into (ring-buffer 3) '(a b))
;;=> (a b)
(into (ring-buffer 3) '(a b c d e))
;;=> (c d e)
(pop (into (ring-buffer 3) '(a b c d e)))
;;=> (d e)
(peek (into (ring-buffer 3) '(a b c d e)))
The project uses lein-doo to run cljs tests. So for example, if
phantomjs is in the path, the tests can be run with:
$ lein doo phantom test
ring-buffer was originally created by Alan Malloy. In December 2018 it was moved to CLJ Commons for continued maintenance.
It could previously be found at amalloy/ring-buffer. clj-commons/ring-buffer is the canonical repository now.
Copyright © 2012 Alan Malloy
Distributed under the Eclipse Public License, the same as Clojure.
Edit on GitHub