ringbuf

Documentation

Index

• Variables
• type RingBuf
  • func NewRingBuf(size int, begin int64) (rb RingBuf)
  • func (rb *RingBuf) Begin() int64
  • func (rb *RingBuf) Dump() []byte
  • func (rb *RingBuf) End() int64
  • func (rb *RingBuf) EqualAt(p []byte, off int64) bool
  • func (rb *RingBuf) Evacuate(off int64, length int) (newOff int64)
  • func (rb *RingBuf) ReadAt(p []byte, off int64) (n int, err error)
  • func (rb *RingBuf) Resize(newSize int)
  • func (rb *RingBuf) Size() int64
  • func (rb *RingBuf) Skip(length int64)
  • func (rb *RingBuf) String() string
  • func (rb *RingBuf) Write(p []byte) (n int, err error)
  • func (rb *RingBuf) WriteAt(p []byte, off int64) (n int, err error)

Variables

var ErrOutOfRange = errors.New("out of range")

Types

type RingBuf

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

Ring buffer has a fixed size, when data exceeds the size, old data will be overwritten by new data. It only contains the data in the stream from begin to end

func NewRingBuf

func NewRingBuf(size int, begin int64) (rb RingBuf)

func (*RingBuf) Begin

func (rb *RingBuf) Begin() int64

func (*RingBuf) Dump

func (rb *RingBuf) Dump() []byte

Create a copy of the buffer.

func (*RingBuf) End

func (rb *RingBuf) End() int64

func (*RingBuf) EqualAt

func (rb *RingBuf) EqualAt(p []byte, off int64) bool

func (*RingBuf) Evacuate

func (rb *RingBuf) Evacuate(off int64, length int) (newOff int64)

Evacuate read the data at off, then write it to the the data stream, Keep it from being overwritten by new data.

func (*RingBuf) ReadAt

func (rb *RingBuf) ReadAt(p []byte, off int64) (n int, err error)

read up to len(p), at off of the data stream.

func (*RingBuf) Resize

func (rb *RingBuf) Resize(newSize int)

func (*RingBuf) Size

func (rb *RingBuf) Size() int64

func (*RingBuf) Skip

func (rb *RingBuf) Skip(length int64)

func (*RingBuf) String

func (rb *RingBuf) String() string

func (*RingBuf) Write

func (rb *RingBuf) Write(p []byte) (n int, err error)

func (*RingBuf) WriteAt

func (rb *RingBuf) WriteAt(p []byte, off int64) (n int, err error)