circbuf

Documentation

Index

• type Buffer
  • func NewBuffer(maxSize int) (*Buffer, error)
  • func (c *Buffer) Bytes() []byte
  • func (c *Buffer) Size() int
  • func (c *Buffer) TotalWritten() int
  • func (c *Buffer) Write(buf []byte) (int, error)

Types

type Buffer

type Buffer struct {
	// contains filtered or unexported fields
}

Buffer represents a dynamic circular (ring) buffer. It will append data freely to the underlying buffer until maxSize is hit. Once hit, new writes will be written in a circular fashion.

func NewBuffer

func NewBuffer(maxSize int) (*Buffer, error)

NewBuffer creates and returns a Buffer pointer with a max size.

func (*Buffer) Bytes

func (c *Buffer) Bytes() []byte

func (*Buffer) Size

func (c *Buffer) Size() int

func (*Buffer) TotalWritten

func (c *Buffer) TotalWritten() int

func (*Buffer) Write

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

Write implements io.Writer.