ringbuffer

Documentation

Index

• Variables
• type RingBuffer
  • func New(cap int) *RingBuffer
  • func (rb *RingBuffer) Close() error
  • func (rb *RingBuffer) Drain() []interface{}
  • func (rb *RingBuffer) Pop() (interface{}, error)
  • func (rb *RingBuffer) Push(val interface{}) (bool, error)

Variables

var ErrClosed = fmt.Errorf("closed")

ErrClosed is used to indicate the ringbuffer has been closed.

Types

type RingBuffer

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

RingBuffer implements a fixed-size buffer which will drop oldest data if full.

func New

func New(cap int) *RingBuffer

New creates new RingBuffer.

func (*RingBuffer) Close

func (rb *RingBuffer) Close() error

Close closes the ringbuffer.

func (*RingBuffer) Drain

func (rb *RingBuffer) Drain() []interface{}

Drain returns all the data in the buffer.

NOTE: it can be used after closed to make sure the data have been consumed.

func (*RingBuffer) Pop

func (rb *RingBuffer) Pop() (interface{}, error)

Pop pops the value in the buffer.

NOTE: it returns ErrClosed if the buffer has been closed.

func (*RingBuffer) Push

func (rb *RingBuffer) Push(val interface{}) (bool, error)

Push pushes value into buffer and return whether it covers the oldest data or not.