k3s/vendor/github.com/armon/circbuf
Darren Shepherd d246c89254 go mod vendor 2019-09-05 15:16:39 -07:00
..
.gitignore go mod vendor 2019-09-05 15:16:39 -07:00
LICENSE go mod vendor 2019-09-05 15:16:39 -07:00
README.md Update vendor 2019-01-11 21:58:27 -07:00
circbuf.go Update vendor 2019-01-11 21:58:27 -07: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!")
}