k3s/vendor/github.com/armon/circbuf
Jeff Grafton aee5f457db update BUILD files 2017-10-15 18:18:13 -07:00
..
.gitignore bump:(github.com/armon/circbuf):bbbad097214e2918d8543d5201d12bfd7bca254d 2017-01-23 12:25:56 -05:00
BUILD update BUILD files 2017-10-15 18:18:13 -07:00
LICENSE bump:(github.com/armon/circbuf):bbbad097214e2918d8543d5201d12bfd7bca254d 2017-01-23 12:25:56 -05:00
README.md bump:(github.com/armon/circbuf):bbbad097214e2918d8543d5201d12bfd7bca254d 2017-01-23 12:25:56 -05:00
circbuf.go bump:(github.com/armon/circbuf):bbbad097214e2918d8543d5201d12bfd7bca254d 2017-01-23 12:25:56 -05: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!")
}