pool

Documentation

Index

• type Pool
  • func NewPool[T any](newFn func() T) *Pool[T]
  • func (p *Pool[T]) Get() T
  • func (p *Pool[T]) Put(v T)
• type ResetPool
  • func NewResetPool[T Resetable](newFn func() T) *ResetPool[T]
  • func (p *ResetPool[T]) Put(v T)
• type Resetable

Types

type Pool

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

Pool is a sync.Pool wrapped for type-safety

func NewPool

func NewPool[T any](newFn func() T) *Pool[T]

func (*Pool[T]) Get

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

func (*Pool[T]) Put

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

type ResetPool

type ResetPool[T Resetable] struct {
	*Pool[T]
}

ResetPool is a sync.Pool wrapped with a generic Resetable interface, the pool calls Reset before returning an item to the pool.

func NewResetPool

func NewResetPool[T Resetable](newFn func() T) *ResetPool[T]

func (*ResetPool[T]) Put

func (p *ResetPool[T]) Put(v T)

type Resetable

type Resetable interface {
	Reset()
}