alloc

Documentation

Overview

Package alloc provides a light-weight memory allocation mechanism.

Index

• Constants
• type Buffer
  • func CreateBuffer(container []byte, parent Pool) *Buffer
  • func NewBuffer() *Buffer
  • func NewBufferWithSize(size int) *Buffer
  • func NewLargeBuffer() *Buffer
  • func NewLocalBuffer(size int) *Buffer
  • func NewSmallBuffer() *Buffer
  • func (b *Buffer) Append(data []byte) *Buffer
  • func (b *Buffer) AppendBytes(bytes ...byte) *Buffer
  • func (b *Buffer) AppendString(s string) *Buffer
  • func (b *Buffer) AppendUint16(v uint16) *Buffer
  • func (b *Buffer) AppendUint32(v uint32) *Buffer
  • func (b *Buffer) Bytes() []byte
  • func (b *Buffer) Clear() *Buffer
  • func (b *Buffer) FillFrom(reader io.Reader) (int, error)
  • func (b *Buffer) IsEmpty() bool
  • func (b *Buffer) IsFull() bool
  • func (b *Buffer) Len() int
  • func (b *Buffer) Prepend(data []byte) *Buffer
  • func (b *Buffer) PrependBytes(data ...byte) *Buffer
  • func (b *Buffer) PrependHash(h hash.Hash) *Buffer
  • func (b *Buffer) PrependUint16(v uint16) *Buffer
  • func (b *Buffer) PrependUint32(v uint32) *Buffer
  • func (b *Buffer) Read(data []byte) (int, error)
  • func (b *Buffer) Release()
  • func (b *Buffer) Reset() *Buffer
  • func (b *Buffer) Slice(from, to int) *Buffer
  • func (b *Buffer) SliceBack(offset int) *Buffer
  • func (b *Buffer) SliceFrom(from int) *Buffer
  • func (b *Buffer) String() string
  • func (b *Buffer) Write(data []byte) (int, error)
• type BufferPool
  • func NewBufferPool(bufferSize, poolSize int) *BufferPool
  • func (p *BufferPool) Allocate() *Buffer
  • func (p *BufferPool) Free(buffer *Buffer)
• type Pool

Constants

const (
	SmallBufferSize = 1600 - defaultOffset
	BufferSize      = 8*1024 - defaultOffset
	LargeBufferSize = 64*1024 - defaultOffset
)

Types

type Buffer

type Buffer struct {
	Value []byte
	// contains filtered or unexported fields
}

Buffer is a recyclable allocation of a byte array. Buffer.Release() recycles the buffer into an internal buffer pool, in order to recreate a buffer more quickly.

func CreateBuffer

func CreateBuffer(container []byte, parent Pool) *Buffer

func NewBuffer

func NewBuffer() *Buffer

NewBuffer creates a Buffer with 8K bytes of arbitrary content.

func NewBufferWithSize

func NewBufferWithSize(size int) *Buffer

func NewLargeBuffer

func NewLargeBuffer() *Buffer

NewLargeBuffer creates a Buffer with 64K bytes of arbitrary content.

func NewLocalBuffer

func NewLocalBuffer(size int) *Buffer

func NewSmallBuffer

func NewSmallBuffer() *Buffer

NewSmallBuffer creates a Buffer with 1K bytes of arbitrary content.

func (*Buffer) Append

func (b *Buffer) Append(data []byte) *Buffer

Append appends a byte array to the end of the buffer.

func (*Buffer) AppendBytes

func (b *Buffer) AppendBytes(bytes ...byte) *Buffer

AppendBytes appends one or more bytes to the end of the buffer.

func (*Buffer) AppendString

func (b *Buffer) AppendString(s string) *Buffer

AppendString appends a given string to the end of the buffer.

func (*Buffer) AppendUint16

func (b *Buffer) AppendUint16(v uint16) *Buffer

func (*Buffer) AppendUint32

func (b *Buffer) AppendUint32(v uint32) *Buffer

func (*Buffer) Bytes

func (b *Buffer) Bytes() []byte

Bytes returns the content bytes of this Buffer.

func (*Buffer) Clear

func (b *Buffer) Clear() *Buffer

Clear clears the content of the buffer, results an empty buffer with Len() = 0.

func (*Buffer) FillFrom

func (b *Buffer) FillFrom(reader io.Reader) (int, error)

func (*Buffer) IsEmpty

func (b *Buffer) IsEmpty() bool

func (*Buffer) IsFull

func (b *Buffer) IsFull() bool

IsFull returns true if the buffer has no more room to grow.

func (*Buffer) Len

func (b *Buffer) Len() int

Len returns the length of the buffer content.

func (*Buffer) Prepend

func (b *Buffer) Prepend(data []byte) *Buffer

Prepend prepends bytes in front of the buffer. Caller must ensure total bytes prepended is no more than 16 bytes.

func (*Buffer) PrependBytes

func (b *Buffer) PrependBytes(data ...byte) *Buffer

func (*Buffer) PrependHash

func (b *Buffer) PrependHash(h hash.Hash) *Buffer

func (*Buffer) PrependUint16

func (b *Buffer) PrependUint16(v uint16) *Buffer

func (*Buffer) PrependUint32

func (b *Buffer) PrependUint32(v uint32) *Buffer

func (*Buffer) Read

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

Read implements io.Reader.Read().

func (*Buffer) Release

func (b *Buffer) Release()

Release recycles the buffer into an internal buffer pool.

func (*Buffer) Reset

func (b *Buffer) Reset() *Buffer

Reset resets this Buffer into its original state.

func (*Buffer) Slice

func (b *Buffer) Slice(from, to int) *Buffer

Slice cuts the buffer at the given position.

func (*Buffer) SliceBack

func (b *Buffer) SliceBack(offset int) *Buffer

SliceBack extends the Buffer to its front by offset bytes. Caller must ensure cumulated offset is no more than 16.

func (*Buffer) SliceFrom

func (b *Buffer) SliceFrom(from int) *Buffer

SliceFrom cuts the buffer at the given position.

func (*Buffer) String

func (b *Buffer) String() string

func (*Buffer) Write

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

Write implements Write method in io.Writer.

type BufferPool

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

func NewBufferPool

func NewBufferPool(bufferSize, poolSize int) *BufferPool

func (*BufferPool) Allocate

func (p *BufferPool) Allocate() *Buffer

func (*BufferPool) Free

func (p *BufferPool) Free(buffer *Buffer)

type Pool

type Pool interface {
	Allocate() *Buffer
	Free(*Buffer)
}