Source File
	buffer.go

Belonging Package
	github.com/alitto/pond/v2/internal/linkedbuffer

package linkedbuffer

import (
	"errors"
)

var ErrEOF = errors.New("EOF")

// buffer implements a generic buffer that can store any type of data.
// It is not thread-safe and should be used with a mutex.
// It is used by LinkedBuffer to store data and is not intended to be used directly.
type buffer[T any] struct {
	data           []T
	nextWriteIndex int
	nextReadIndex  int
	next           *buffer[T]
	zero           T
}

func newBuffer[T any](capacity int) *buffer[T] {
	return &buffer[T]{
		data: make([]T, capacity),
	}
}

// Cap returns the capacity of the buffer.
func (b *buffer[T]) Cap() int {
	return cap(b.data)
}

// Len returns the number of elements in the buffer.
func (b *buffer[T]) Len() int {
	return b.nextWriteIndex - b.nextReadIndex
}

// Write writes a value to the buffer.
// If the buffer is full, it returns an EOF error.
func (b *buffer[T]) Write(value T) error {
	if b.nextWriteIndex >= b.Cap() {
		// Buffer is full
		return ErrEOF
	}

	b.data[b.nextWriteIndex] = value
	b.nextWriteIndex++
	return nil
}

// Read reads a value from the buffer.
// If the buffer is empty, it returns an EOF error.
// If the buffer has been read completely, it returns an EOF error.
func (b *buffer[T]) Read() (value T, err error) {
	if b.nextReadIndex >= b.Cap() || (b.next == nil && b.nextReadIndex >= b.nextWriteIndex) {
		// Buffer read completely, return EOF error
		err = ErrEOF
		return
	}

	value = b.data[b.nextReadIndex]

	// Remove reference to read value to prevent memory leaks caused by
	// holding references to submitted tasks.
	// See https://github.com/alitto/pond/issues/110
	b.data[b.nextReadIndex] = b.zero

	b.nextReadIndex++
	return
}

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.