sahmad98/go-ringbuffer

A ringbuffer implementation in golang

ringbuffer

Simple RingBuffer pacakge Ringbuffer is non blocking for readers and writers, writers will overwrite older data in a circular fashion. Readers will read from the current position and update it.

Usage

type RingBuffer

type RingBuffer struct {
	Size      int           // Size of the Ringbuffer
	Container []interface{} // Array container of objects
	Reader    int           // Reader position
	Writer    int           // Writer Position
}

RingBuffer Structure

func NewRingBuffer

func NewRingBuffer(size int) *RingBuffer

Create a new RingBuffer of initial size "size" Returns a pointer to the new RingBuffer

func (*RingBuffer) Read

func (r *RingBuffer) Read() interface{}

Read single object from the RingBuffer

func (*RingBuffer) Write

func (r *RingBuffer) Write(v interface{})

Write object into the RingBuffer

go-ringbuffer's Issues

Consider a release including a patch version

Dear sahmad98,

Using go modules I seem unable to import your package directly, as the release tags are lacking a patch version.

As a workaround, for now I've forked this repository in order to create the an additional release including the patch version (v1.1.0).

You might want to add such a release to this repo as well, as it will make it easier for others to use the code. Also, I'd rather reference this repo, as future updates/fixes might be published here first.

If you don't feel like you want to add it, just close this issue :)