ringbuf

README

Ring Buffer

Design

1 item

in |out | w | r ----+----+----+---- 0 | 0 | 0 | 0 1 | 0 | 1 | 0 1 | 1 | 1 | 1

Documentation

Overview

Package ringbuf provides ring buffer.

Index

• type Buffer
  • func New[T any](capacity int) *Buffer[T]
  • func (b *Buffer[T]) Clear()
  • func (b *Buffer[T]) Empty() bool
  • func (b *Buffer[T]) Get() (T, bool)
  • func (b *Buffer[T]) Len() int
  • func (b *Buffer[T]) Peek(n int) T
  • func (b *Buffer[T]) Put(v T)

Types

type Buffer

type Buffer[T any] struct {
	// contains filtered or unexported fields
}

Buffer provides ring buffer.

func New

func New[T any](capacity int) *Buffer[T]

New creates a ring buffer with specified capacity.

func (*Buffer[T]) Clear

func (b *Buffer[T]) Clear()

Clear remove all values.

func (*Buffer[T]) Empty

func (b *Buffer[T]) Empty() bool

Empty checks the buffer is empty or not.

func (*Buffer[T]) Get

func (b *Buffer[T]) Get() (T, bool)

Get retrieves a value.

func (*Buffer[T]) Len

func (b *Buffer[T]) Len() int

Len returns number of valid items in the ringbuf

func (*Buffer[T]) Peek

func (b *Buffer[T]) Peek(n int) T

Peek peeks checks a n'th value in ringbuf without removing the value.

func (*Buffer[T]) Put

func (b *Buffer[T]) Put(v T)

Put puts a value.