circlebuffer

README

circlebuffer

circlebuffer provides a modern circular buffer Go library with support for generics.

Getting Started

The circlebuffer package can be added to a project with go-get.

go get cattlecloud.net/go/circlebuffer@latest

import "cattlecloud.net/go/circlebuffer"

Examples

Inserting elements

buf := circlebuffer.New[string](1024)
buf.Insert("alice")
buf.Insert("bob")

Iterating elements

for item := range buf.All() {
  // ...
}

License

The cattlecloud.net/go/circlebuffer module is open source under the BSD license.

Documentation

Index

• type Array
  • func New[T any](capacity int) Array[T]

Types

type Array

type Array[T any] interface {
	All() iter.Seq[T]
	Insert(T)
	Size() int
	Empty() bool
}

func New

func New[T any](capacity int) Array[T]