iwita 21196b4a6d added v1.15.4 5 years ago
..
.gitignore 21196b4a6d added v1.15.4 5 years ago
BUILD 21196b4a6d added v1.15.4 5 years ago
LICENSE 21196b4a6d added v1.15.4 5 years ago
README.md 21196b4a6d added v1.15.4 5 years ago
circbuf.go 21196b4a6d added v1.15.4 5 years ago

README.md

circbuf

This repository provides the circbuf package. This provides a Buffer object which is a circular (or ring) buffer. It has a fixed size, but can be written to infinitely. Only the last size bytes are ever retained. The buffer implements the io.Writer interface.

Documentation

Full documentation can be found on Godoc

Usage

The circbuf package is very easy to use:

buf, _ := NewBuffer(6)
buf.Write([]byte("hello world"))

if string(buf.Bytes()) != " world" {
    panic("should only have last 6 bytes!")
}