Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justinhoward/fixed_size_buffer
https://github.com/justinhoward/fixed_size_buffer
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/justinhoward/fixed_size_buffer
- Owner: justinhoward
- License: mit
- Created: 2021-03-12T15:53:00.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-19T05:18:07.000Z (almost 4 years ago)
- Last Synced: 2024-12-08T19:41:56.277Z (about 1 month ago)
- Language: Ruby
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
FixedSizeBuffer
==================
[](https://badge.fury.io/rb/fixed_size_buffer)
[](https://github.com/justinhoward/fixed_size_buffer/actions?query=workflow%3ACI+branch%3Amaster)
[](https://www.codacy.com/gh/justinhoward/fixed_size_buffer/dashboard?utm_source=github.com&utm_medium=referral&utm_content=justinhoward/fixed_size_buffer&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/justinhoward/fixed_size_buffer/dashboard?utm_source=github.com&utm_medium=referral&utm_content=justinhoward/fixed_size_buffer&utm_campaign=Badge_Coverage)
[](http://inch-ci.org/github/justinhoward/fixed_size_buffer)
A ring buffer with a fixed capacity
```ruby
buffer = FixedSizeBuffer.new(3)
buffer.write(1)
buffer.write(2)
buffer.to_a # [1, 2]
buffer.read # => 1
buffer.read # => 2
```
What is a Ring Buffer?
------------------------
A ring buffer is a continuously writable and continuously readable data
structure that is contained in a fixed amount of memory. It can be
conceptualized as writing values around a circular array. As we write, we move
clockwise around the circle, and the reader trails around in the same direction.
The advantages of a ring buffer as opposed to pushing and shifting an array is
that a ring buffer only can be heap allocated once, and since it's a fixed size,
it never needs to be reallocated.
Installation
---------------
Add it to your `Gemfile`:
```ruby
gem 'fixed_size_buffer'
```
Or install it manually:
```sh
gem install fixed_size_buffer
```
API Documentation
--------------
API docs can be read [on rubydoc.info][api docs], inline in the source code, or
you can generate them yourself with Ruby `yard`:
```sh
bin/yardoc
```
Then open `doc/index.html` in your browser.
Usage
-----------
Create a new ring buffer with a given capacity
```ruby
buffer = FixedSizeBuffer.new(100)
```
Then write and read from the buffer
```ruby
buffer = FixedSizeBuffer.new(2)
buffer.empty? # => true
buffer.size # => 0
buffer.write('hello')
buffer.write('world')
buffer.size # => 2
buffer.full? # => true
buffer.to_a # => ['hello', 'world']
buffer.peek # => 'hello'
buffer.read # => 'hello'
buffer.read # => 'world'
buffer.read # => nil
```
Once the buffer fills up, it will overwrite the oldest values.
```ruby
buffer = FixedSizeBuffer.new(2)
buffer.write('hello')
buffer.write('world')
buffer.write('again')
buffer.read # => 'world'
```
[api docs]: https://www.rubydoc.info/github/justinhoward/fixed_size_buffer/master