pool

type Allocator[T any] func() *T

type Cleaner[T any] func(*T)

type CleanupPolicy struct {
	// Enabled determines if automatic cleanup is enabled.
	Enabled bool
	// Interval is how often the cleanup should run.
	Interval time.Duration
	// MinUsageCount is the number of usage BELOW which an object will be evicted.
	MinUsageCount int64
}

type Config[T any, P Poolable[T]] struct {
	// Cleanup defines the cleanup policy for the pool
	Cleanup CleanupPolicy

	// Growth defined the growth policy for the pool
	Growth GrowthPolicy

	// Allocator is the function to create new objects
	Allocator Allocator[T]

	// Cleaner is the function to clean objects before returning them to the pool
	Cleaner Cleaner[T]
}

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

type GcLevel string

type GrowthPolicy struct {
	// MaxPoolSize defines the maximum number of objects the pool is allowed to grow to.
	MaxPoolSize int64

	// Enable activates growth control. If disabled, the pool will grow and shrink freely based on your configuration.
	Enable bool
}

type Poolable[T any] interface {
	*T
	// GetNext returns the next object in the pool's linked list
	GetNext() *T
	// SetNext sets the next object in the pool's linked list
	SetNext(next *T)
	// GetUsageCount returns the number of times this object has been used
	GetUsageCount() int64
	// IncrementUsage increments the usage count of this object
	IncrementUsage()
	// ResetUsage resets the usage count to 0
	ResetUsage()
	// SetShardIndex sets the shard index for this object
	SetShardIndex(index int)
	// GetShardIndex returns the shard index for this object
	GetShardIndex() int
}

type Shard[T any, P Poolable[T]] struct {
	Head   atomic.Pointer[T] // 8 bytes
	Single atomic.Pointer[T] // 8 bytes - fast path for single object
	Cond   *sync.Cond        // 8 bytes
	Mutex  *sync.Mutex       // 8 bytes
	// contains filtered or unexported fields
}

type ShardedPool[T any, P Poolable[T]] struct {
	// shards is a slice of pool shards, each on its own cache line
	Shards []*Shard[T, P]

	// CurrentPoolLength changes at runtime, keeping track of how many uniqe objects have been created
	CurrentPoolLength atomic.Int64
	// contains filtered or unexported fields
}