pool

Documentation

Index

• Variables
• type BucketedBytes
  • func MustNewBucketedBytes(minSize, maxSize int, factor float64, maxTotal uint64) *BucketedBytes
  • func NewBucketedBytes(minSize, maxSize int, factor float64, maxTotal uint64) (*BucketedBytes, error)
  • func (p *BucketedBytes) Get(sz int) (*[]byte, error)
  • func (p *BucketedBytes) Put(b *[]byte)
• type Bytes
• type NoopBytes
  • func (p NoopBytes) Get(sz int) (*[]byte, error)
  • func (p NoopBytes) Put(*[]byte)

Variables

var ErrPoolExhausted = errors.New("pool exhausted")

ErrPoolExhausted is returned if a pool cannot provide the request bytes.

Types

type BucketedBytes

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

BucketedBytes is a bucketed pool for variably sized byte slices. It can be configured to not allow more than a maximum number of bytes being used at a given time. Every byte slice obtained from the pool must be returned.

func MustNewBucketedBytes

func MustNewBucketedBytes(minSize, maxSize int, factor float64, maxTotal uint64) *BucketedBytes

MustNewBucketedBytes is like NewBucketedBytes but panics if construction fails. Useful for package internal pools.

func NewBucketedBytes

func NewBucketedBytes(minSize, maxSize int, factor float64, maxTotal uint64) (*BucketedBytes, error)

NewBucketedBytes returns a new Bytes with size buckets for minSize to maxSize increasing by the given factor and maximum number of used bytes. No more than maxTotal bytes can be used at any given time unless maxTotal is set to 0.

func (*BucketedBytes) Get

func (p *BucketedBytes) Get(sz int) (*[]byte, error)

Get returns a new byte slice that fits the given size.

func (*BucketedBytes) Put

func (p *BucketedBytes) Put(b *[]byte)

Put returns a byte slice to the right bucket in the pool.

type Bytes

type Bytes interface {
	// Get returns a new byte slices that fits the given size.
	Get(sz int) (*[]byte, error)
	// Put returns a byte slice to the right bucket in the pool.
	Put(b *[]byte)
}

Bytes is a pool of bytes that can be reused.

type NoopBytes

type NoopBytes struct{}

NoopBytes is pool that always allocated required slice on heap and ignore puts.

func (NoopBytes) Get

func (p NoopBytes) Get(sz int) (*[]byte, error)

func (NoopBytes) Put

func (p NoopBytes) Put(*[]byte)