pool

Documentation

Overview

Package pool provides a pool for reusing objects.

Index

• func AllRefsCount() map[string]int
• type Synced
  • func Register[T any](name string) *Synced[T]
  • func (p *Synced[T]) Get() T
  • func (p *Synced[T]) Put(v T)
  • func (p *Synced[T]) RefsCount() int
• type Trackable

Functions

func AllRefsCount

func AllRefsCount() map[string]int

AllRefsCount returns the reference count of all pools.

Types

type Synced

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

Synced is a pool that is safe for concurrent use.

func Register

func Register[T any](name string) *Synced[T]

Register registers a new pool with the given name.

func (*Synced[T]) Get

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

Get returns an object from the pool. If the pool is empty, nil is returned.

func (*Synced[T]) Put

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

Put puts an object back to the pool.

func (*Synced[T]) RefsCount

func (p *Synced[T]) RefsCount() int

RefsCount returns the reference count of the pool.

type Trackable

type Trackable interface {
	// RefsCount returns the reference count of the pool.
	RefsCount() int
}

Trackable is the interface that wraps the RefsCount method.