open-consul/vendor/github.com/armon/circbuf
Jeff Mitchell b43800125c
Update vendoring from go mod. (#5566)
2019-03-26 17:50:42 -04:00
..
.gitignore Update vendoring from go mod. (#5566) 2019-03-26 17:50:42 -04:00
LICENSE Update vendoring from go mod. (#5566) 2019-03-26 17:50:42 -04: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!")
}