restic/internal/archiver/buffer.go

package archiver

import "sync"

// buffer is a reusable buffer. After the buffer has been used, Release should
// be called so the underlying slice is put back into the pool.
type buffer struct {
	Data []byte
	pool *bufferPool
}

// Release puts the buffer back into the pool it came from.
func (b *buffer) Release() {
	pool := b.pool
	if pool == nil || cap(b.Data) > pool.defaultSize {
		return
	}

	pool.pool.Put(b)
}

// bufferPool implements a limited set of reusable buffers.
type bufferPool struct {
	pool        sync.Pool
	defaultSize int
}

// newBufferPool initializes a new buffer pool. The pool stores at most max
// items. New buffers are created with defaultSize. Buffers that have grown
// larger are not put back.
func newBufferPool(defaultSize int) *bufferPool {
	b := &bufferPool{
		defaultSize: defaultSize,
	}
	b.pool = sync.Pool{New: func() any {
		return &buffer{
			Data: make([]byte, defaultSize),
			pool: b,
		}
	}}
	return b
}

// Get returns a new buffer, either from the pool or newly allocated.
func (pool *bufferPool) Get() *buffer {
	return pool.pool.Get().(*buffer)
}