buffer

Documentation

Overview

Package buffer provides a custom buffer type that includes metrics for tracking buffer usage. It also provides a pool for managing buffer reusability.

Index

• func ReadCloser(data []byte, onClose func()) *readCloser
• type Buffer
  • func NewBuffer() *Buffer
  • func (b *Buffer) Grow(size int)
  • func (b *Buffer) Write(data []byte) (int, error)
• type Pool
  • func NewBufferPool(opts ...PoolOpts) *Pool
  • func (p *Pool) Get() *Buffer
  • func (p *Pool) Put(buf *Buffer)
• type PoolOpts

Functions

func ReadCloser

func ReadCloser(data []byte, onClose func()) *readCloser

ReadCloser creates a new instance of readCloser.

Types

type Buffer

type Buffer struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

Buffer is a wrapper around bytes.Buffer that includes a timestamp for tracking Buffer checkout duration.

func NewBuffer

func NewBuffer() *Buffer

NewBuffer creates a new instance of Buffer.

func (*Buffer) Grow

func (b *Buffer) Grow(size int)

func (*Buffer) Write

func (b *Buffer) Write(data []byte) (int, error)

Write date to the buffer.

type Pool

type Pool struct {
	*sync.Pool
	// contains filtered or unexported fields
}

Pool of buffers.

func NewBufferPool

func NewBufferPool(opts ...PoolOpts) *Pool

NewBufferPool creates a new instance of BufferPool.

func (*Pool) Get

func (p *Pool) Get() *Buffer

Get returns a Buffer from the pool.

func (*Pool) Put

func (p *Pool) Put(buf *Buffer)

Put returns a Buffer to the pool.

type PoolOpts

type PoolOpts func(pool *Pool)

PoolOpts is a function that configures a BufferPool.