bufpool

Documentation

Overview

Package bufpool is a freelist for bytes.Buffer objects.

Index

• func CopyBytes(buf *bytes.Buffer) []byte
• func Get() *bytes.Buffer
• func Put(b *bytes.Buffer)

Functions

func CopyBytes

func CopyBytes(buf *bytes.Buffer) []byte

CopyBytes returns a copy of the bytes contained in the buffer. This slice is safe from updates in the underlying buffer, allowing the buffer to be placed back in the free list.

func Get

func Get() *bytes.Buffer

Get returns an initialized bytes.Buffer object. It is like new(bytes.Buffer) except it uses the free list. The caller should call Put when finished with the returned object. Since Buffer.Bytes() returns the buffer's underlying slice, it is not safe for that slice to escape the caller. If the bytes need to escape, CopyBytes should be used.

func Put

func Put(b *bytes.Buffer)

Put resets the buffer and adds it to the freelist.