ring

Documentation

Index

• type Buffer
  • func NewBuffer(size int64) *Buffer
  • func (b *Buffer) NewBytesWritten() int64
  • func (b *Buffer) Reset()
  • func (b *Buffer) ResetNewBytesWritten()
  • func (b *Buffer) Write(buf []byte) (int, error)

Types

type Buffer

type Buffer struct {
	*circbuf.Buffer
	// contains filtered or unexported fields
}

Buffer implements a circular buffer. It is a fixed size, and new writes overwrite older data, such that for a buffer of size N, for any amount of writes, only the last N bytes are retained.

func NewBuffer

func NewBuffer(size int64) *Buffer

NewBuffer creates a new buffer of a given size. NewBuffer panics if the size is not greater than 0.

func (*Buffer) NewBytesWritten

func (b *Buffer) NewBytesWritten() int64

NewBytesWritten provides the total number of bytes written since the last reset.

func (*Buffer) Reset

func (b *Buffer) Reset()

Reset resets the buffer so it has no content.

func (*Buffer) ResetNewBytesWritten

func (b *Buffer) ResetNewBytesWritten()

ResetNewBytesWritten resets the new bytes written counter.

func (*Buffer) Write

func (b *Buffer) Write(buf []byte) (int, error)

Write writes up to len(buf) bytes to the internal ring, overriding older data if necessary.