ringbuffer

Documentation

Index

• type Buffer
  • func NewBuffer(size uint) *Buffer
  • func (b *Buffer) Close() error
  • func (b *Buffer) Len() int
  • func (b *Buffer) Read(p []byte) (int, error)
  • func (b *Buffer) Write(p []byte) (int, error)

Types

type Buffer

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

Buffer is a simple implementation of a ring/circular buffer.

func NewBuffer

func NewBuffer(size uint) *Buffer

NewBuffer returns a ring buffer of a given size.

func (*Buffer) Close

func (b *Buffer) Close() error

func (*Buffer) Len

func (b *Buffer) Len() int

func (*Buffer) Read

func (b *Buffer) Read(p []byte) (int, error)

Read reads from the buffer, returning io.EOF if it has read up until where it has written.

func (*Buffer) Write

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

Write writes to the buffer, circularly overwriting data if p exceeds the size of the buffer.