ringlog

Documentation

Overview

Package ringlog contains a limited-size concurrency-safe generic ring log.

Index

• type RingLog
  • func New[T any](max int) *RingLog[T]
  • func (rb *RingLog[T]) Add(t T)
  • func (rb *RingLog[T]) Clear()
  • func (rb *RingLog[T]) GetAll() []T
  • func (rb *RingLog[T]) Len() int

Types

type RingLog

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

RingLog is a concurrency-safe fixed size log window containing entries of [T].

func New

func New[T any](max int) *RingLog[T]

New creates a new RingLog containing at most max items.

func (*RingLog[T]) Add

func (rb *RingLog[T]) Add(t T)

Add appends a new item to the RingLog, possibly overwriting the oldest item in the log if it is already full.

It does nothing if rb is nil.

func (*RingLog[T]) Clear

func (rb *RingLog[T]) Clear()

Clear will empty the ring log.

func (*RingLog[T]) GetAll

func (rb *RingLog[T]) GetAll() []T

GetAll returns a copy of all the entries in the ring log in the order they were added.

It returns nil if rb is nil.

func (*RingLog[T]) Len

func (rb *RingLog[T]) Len() int

Len returns the number of elements in the ring log. Note that this value could change immediately after being returned if a concurrent caller modifies the log.