freepool

Documentation

Overview

Package freepool manages a free pool of objects that are expensive to create.

Index

• type Pool
  • func New[T any](makeNew func() *T, clean func(v *T)) *Pool[T]
  • func NewStruct[T any](cleanItem T) *Pool[T]
  • func (p *Pool[T]) Return(v *T)
  • func (p *Pool[T]) Take() *T

Types

type Pool

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

Pool is a small pool of recently returned objects with built-in cleanup.

func New

func New[T any](makeNew func() *T, clean func(v *T)) *Pool[T]

New returns a new free pool.

func NewStruct

func NewStruct[T any](cleanItem T) *Pool[T]

NewStruct returns a pool that produces provided clean structures.

func (*Pool[T]) Return

func (p *Pool[T]) Return(v *T)

Return returns an item to the pool after cleaning it.

func (*Pool[T]) Take

func (p *Pool[T]) Take() *T

Take returns an item from the pool, and if not available makes a new one.