History

Sean Chittenden 333ff22e9a Manage dependencies via Godep Embrace the future and use Go 1.6's vendor support via Godep. Go 1.5 users should `export GO15VENDOREXPERIMENT=1`		2016-02-12 16:50:37 -08:00
..
.gitignore	Manage dependencies via Godep	2016-02-12 16:50:37 -08:00
LICENSE	Manage dependencies via Godep	2016-02-12 16:50:37 -08:00
README.md	Manage dependencies via Godep	2016-02-12 16:50:37 -08:00
circbuf.go	Manage dependencies via Godep	2016-02-12 16:50:37 -08:00

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!")
}