pools

Documentation

Index

• func Acquire[T any](p *Pools) (T, bool)
• func Release[T any](p *Pools, v T)
• type Pool
  • func Acquire1[T any](p *Pools) (T, bool, Pool[T])
  • func GetPool[T any](p *Pools) Pool[T]
  • func NewPool[T any]() Pool[T]
  • func NewPoolFunc[T any](new func() T) Pool[T]
• type Pools
  • func NewPools() *Pools

Functions

func Acquire

func Acquire[T any](p *Pools) (T, bool)

Acquire returns a value from a generic pool.

func Release

func Release[T any](p *Pools, v T)

Release returns a value to a generic pool.

Types

type Pool

type Pool[T any] interface {
	// Get returns a value from the pool, or false.
	Get() (T, bool)

	// New returns a value from the pool, or creates a new one, panics if no new function.
	New() T

	// Put returns a value to the pool.
	Put(T)
}

Pool is a generic pool interface, which wraps sync.Pool.

func Acquire1

func Acquire1[T any](p *Pools) (T, bool, Pool[T])

Acquire1 returns a value from a generic pool, and its pool.

func GetPool

func GetPool[T any](p *Pools) Pool[T]

GetPool returns a pool for a type.

func NewPool

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

NewPool returns a new pool without a new function.

func NewPoolFunc

func NewPoolFunc[T any](new func() T) Pool[T]

NewPoolFunc returns a new pool with a new function.

type Pools

type Pools struct {
	// contains filtered or unexported fields
}

Pools is a map of pools by type, experimental.

func NewPools

func NewPools() *Pools

NewPools returns a new pools instance.