bufpool

Documentation

Overview

Package bufpool - All credits go to https://github.com/valyala/bytebufferpool. This package uses []byte instead.

Index

• func Get() *bytes.Buffer
• func Put(b *bytes.Buffer)
• type Pool
  • func (p *Pool) Get() *bytes.Buffer
  • func (p *Pool) Put(b *bytes.Buffer)

Functions

func Get

func Get() *bytes.Buffer

Get returns an empty byte buffer from the pool.

Got byte buffer may be returned to the pool via Put call. This reduces the number of memory allocations required for byte buffer management.

func Put

func Put(b *bytes.Buffer)

Put returns byte buffer to the pool.

ByteBuffer.B mustn't be touched after returning it to the pool. Otherwise data races will occur.

Types

type Pool

type Pool struct {
	DisableCalibration bool
	// contains filtered or unexported fields
}

Pool represents byte buffer pool.

Distinct pools may be used for distinct types of byte buffers. Properly determined byte buffer types with their own pools may help to reduce memory waste.

func (*Pool) Get

func (p *Pool) Get() *bytes.Buffer

Get returns new byte buffer with zero length.

The byte buffer may be returned to the pool via Put after the use in order to minimize GC overhead.

func (*Pool) Put

func (p *Pool) Put(b *bytes.Buffer)

Put releases byte buffer obtained via Get to the pool.

The buffer mustn't be accessed after returning to the pool.