ring

Documentation

Overview

Package ring provides an implementation of a ring buffer containing strings.

Index

• type Buffer
  • func New(size int) Buffer
  • func (rb *Buffer) Add(entry string)
  • func (rb *Buffer) Len() int
  • func (rb *Buffer) ReadAll() []string

Types

type Buffer

type Buffer struct {
	// contains filtered or unexported fields
}

Buffer represents a ring buffer. If the buffer is full, the last item in the buffer is replaced with the new item. Can only add entries to the buffer but never remove them.

func New

func New(size int) Buffer

New returns a new RingBuffer.

func (*Buffer) Add

func (rb *Buffer) Add(entry string)

Add adds a new entry to the buffer.

func (*Buffer) Len

func (rb *Buffer) Len() int

Len returns the length of the buffer (number of entries filled).

func (*Buffer) ReadAll

func (rb *Buffer) ReadAll() []string

ReadAll returns a slice of strings with all the elements in the buffer