bytespool

README

bytespool

Package bytespool provides a simple pool implementation for reusing []byte.

go get github.com/humuzhu/bytespool

Usage

buf := bytespool.Acquire(256)
defer bytespool.Release(buf)
// using buf whatever you like

Credits

• libp2p/go-buffer-pool: https://github.com/libp2p/go-buffer-pool

Documentation

Overview

Package bytespool provides a simple pool implementation for reusing []byte.

Example

package main

import (
	"fmt"
	"strings"

	"github.com/humuzhu/bytespool"
)

func main() {
	buf := bytespool.Acquire(256)
	defer bytespool.Release(buf)

	rd := strings.NewReader("bytespool")
	n, err := rd.Read(buf)
	if err != nil {
		return
	}
	name := string(buf[:n])
	fmt.Println(name)
}

Output:

bytespool

Index

• func Acquire(n int) []byte
• func Release(bs []byte)
• type Pool
• type SyncPool
  • func NewSyncPool() *SyncPool
  • func (p *SyncPool) Acquire(n int) []byte
  • func (p *SyncPool) Release(buf []byte)

Examples

• Package

Functions

func Acquire

func Acquire(n int) []byte

Acquire retrieves a byte slice of the appropriate length from the global pool (or allocates a new one).

func Release

func Release(bs []byte)

Release returns a byte slice to the global pool.

Types

type Pool

type Pool interface {
	// Acquire retrieves a byte slice of the appropriate length from the pool or
	// allocates a new one.
	Acquire(n int) []byte

	// Release adds buf to the pool.
	Release(buf []byte)
}

Pool is a pool to handle cases of reusing byte slice of varying sizes.

type SyncPool

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

SyncPool maintains 32 internal pools using sync.Pool, for each power of 2 in 1-32.

func NewSyncPool

func NewSyncPool() *SyncPool

NewSyncPool return a SyncPool instance.

func (*SyncPool) Acquire

func (p *SyncPool) Acquire(n int) []byte

Acquire retrieves a byte slice of the appropriate length from the pool or allocates a new one.

func (*SyncPool) Release

func (p *SyncPool) Release(buf []byte)

Release adds buf to the pool.