container

Documentation

Overview

Package ring, Simple RingBuffer pacakge from https://github.com/sahmad98/go-ringbuffer/blob/master/ring_buffer.go

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.

Index

• type RingBuffer
  • func NewRingBuffer(size int32) *RingBuffer
  • func (r *RingBuffer) Latest() any
  • func (r *RingBuffer) Oldest() any
  • func (r *RingBuffer) Overwrite(v any)
  • func (r *RingBuffer) Read() any
  • func (r *RingBuffer) Write(v any)

Types

type RingBuffer

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

RingBuffer Structure

func NewRingBuffer

func NewRingBuffer(size int32) *RingBuffer

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

func (*RingBuffer) Latest

func (r *RingBuffer) Latest() any

Returns the latest element in the RingBuffer

func (*RingBuffer) Oldest

func (r *RingBuffer) Oldest() any

Returns the oldest element in RingBuffer

func (*RingBuffer) Overwrite

func (r *RingBuffer) Overwrite(v any)

Overwrites the latest data in RingBuffer

func (*RingBuffer) Read

func (r *RingBuffer) Read() any

Read single object from the RingBuffer

func (*RingBuffer) Write

func (r *RingBuffer) Write(v any)

Write object into the RingBuffer