bufferpool

Documentation

Overview

Package bufferpool implements a pool of reusable auto-resizing buffers.

Index

• func Get() *bytes.Buffer
• func GetReader(b []byte) *bytes.Reader
• func New(size int) tank
• func NewTwin(size int) twinTank
• func Put(buf *bytes.Buffer)
• func PutReader(r *bytes.Reader)
• func PutTwin(buf *TwinBuffer)
• func PutTwinCallBack(buf *TwinBuffer, fn func())
• type TwinBuffer
  • func GetTwin() *TwinBuffer
  • func (tw *TwinBuffer) CopyFirstToSecond() (n int64, err error)
  • func (tw *TwinBuffer) CopySecondToFirst() (n int64, err error)
  • func (tw *TwinBuffer) Reset()
  • func (tw *TwinBuffer) String() string
  • func (tw *TwinBuffer) Write(p []byte) (n int, err error)

Functions

func Get

func Get() *bytes.Buffer

Get returns a buffer from the pool.

func GetReader

func GetReader(b []byte) *bytes.Reader

Get returns a byte reader from the pool.

func New

func New(size int) tank

New instantiates a new bytes.Buffer pool with a custom pre-allocated buffer size.

func NewTwin

func NewTwin(size int) twinTank

NewTwin instantiates a new TwinBuffer pool with a custom pre-allocated buffer size. The fields `First` and `Second` will have the same size.

func Put

func Put(buf *bytes.Buffer)

Put returns a buffer to the pool. The buffer is reset before it is put back into circulation.

func PutReader

func PutReader(r *bytes.Reader)

Put returns a byte reader to the pool. The reader is reset before it is put back into circulation.

func PutTwin

func PutTwin(buf *TwinBuffer)

PutTwin returns a twin buffer to the pool. The buffers get reset before they are put back into circulation.

func PutTwinCallBack

func PutTwinCallBack(buf *TwinBuffer, fn func())

PutTwinCallBack same as PutTwin but executes fn after buf has been returned into the pool.

buf := twinBuf.Get()
defer twinBuf.PutCallBack(buf, wg.Done)

Types

type TwinBuffer

type TwinBuffer struct {
	First  *bytes.Buffer
	Second *bytes.Buffer
}

TwinBuffer contains two buffers.

func GetTwin

func GetTwin() *TwinBuffer

GetTwin returns a buffer containing two buffers, `First` and `Second`, from the pool.

func (*TwinBuffer) CopyFirstToSecond

func (tw *TwinBuffer) CopyFirstToSecond() (n int64, err error)

CopyFirstToSecond resets the second buffer and copies the content from the first buffer to the second buffer. First buffer gets eventually reset.

func (*TwinBuffer) CopySecondToFirst

func (tw *TwinBuffer) CopySecondToFirst() (n int64, err error)

CopySecondToFirst resets the first buffer and copies the content from the second buffer to the first buffer. Second buffer gets eventually reset.

func (*TwinBuffer) Reset

func (tw *TwinBuffer) Reset()

Reset resets both buffers.

func (*TwinBuffer) String

func (tw *TwinBuffer) String() string

String prints the buffers content for debug purposes.

func (*TwinBuffer) Write

func (tw *TwinBuffer) Write(p []byte) (n int, err error)

Write writes to both buffers one after another.