buffer

Documentation

Overview

Package buffer implements compile.CodeBuffer and compile.DataBuffer.

Index

• Variables
• type Dynamic
  • func NewDynamic(b []byte) *Dynamic
  • func NewDynamicHint(b []byte, maxSizeHint int) *Dynamic
  • func (d *Dynamic) Bytes() []byte
  • func (d *Dynamic) Extend(addLen int) []byte
  • func (d *Dynamic) PutByte(value byte)
  • func (d *Dynamic) ResizeBytes(newLen int) []byte
• type Limited
  • func NewLimited(b []byte, maxSize int) *Limited
  • func (l *Limited) Bytes() []byte
  • func (l *Limited) Extend(n int) []byte
  • func (l *Limited) PutByte(value byte)
  • func (l *Limited) ResizeBytes(n int) []byte
• type Static
  • func MakeStatic(b []byte) Static
  • func NewStatic(b []byte) *Static
  • func (s *Static) Bytes() []byte
  • func (s *Static) Cap() int
  • func (s *Static) Extend(n int) []byte
  • func (s *Static) PutByte(value byte)
  • func (s *Static) ResizeBytes(n int) []byte

Variables

var (
	ErrSizeLimit  = sizeError("buffer size limit exceeded")
	ErrStaticSize = sizeError("static buffer capacity exceeded")
)

These errors implement interface{ OutputSizeLimit() bool }.

Types

type Dynamic

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

Dynamic is a variable-capacity buffer. The default value is a valid buffer.

func NewDynamic

func NewDynamic(b []byte) *Dynamic

NewDynamic buffer is initially empty (b is truncated).

func NewDynamicHint

func NewDynamicHint(b []byte, maxSizeHint int) *Dynamic

NewDynamicHint avoids making excessive allocations if the maximum buffer size can be estimated in advance.

func (*Dynamic) Bytes

func (d *Dynamic) Bytes() []byte

Bytes doesn't panic.

func (*Dynamic) Extend

func (d *Dynamic) Extend(addLen int) []byte

Extend doesn't panic unless out of memory.

func (*Dynamic) PutByte

func (d *Dynamic) PutByte(value byte)

PutBytes doesn't panic unless out of memory.

func (*Dynamic) ResizeBytes

func (d *Dynamic) ResizeBytes(newLen int) []byte

ResizeBytes doesn't panic unless out of memory.

type Limited

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

Limited is a dynamic buffer with a maximum size. The default value is an empty buffer that cannot grow.

func NewLimited

func NewLimited(b []byte, maxSize int) *Limited

NewLimited buffer with a maximum size. It is initially empty (b is truncated).

func (*Limited) Bytes

func (l *Limited) Bytes() []byte

Bytes doesn't panic.

func (*Limited) Extend

func (l *Limited) Extend(n int) []byte

Extend panics with ErrSizeLimit if n bytes cannot be appended to the buffer.

func (*Limited) PutByte

func (l *Limited) PutByte(value byte)

PutByte panics with ErrSizeLimit if the buffer is already full.

func (*Limited) ResizeBytes

func (l *Limited) ResizeBytes(n int) []byte

ResizeBytes panics with ErrSizeLimit if n is larger than maximum buffer size.

type Static

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

Static is a fixed-capacity buffer, for wrapping a memory-mapped region. The default value is a zero-capacity buffer.

func MakeStatic

func MakeStatic(b []byte) Static

MakeStatic buffer with len(b) as its capacity. It is initially empty (b is truncated).

This function can be used in field initializer expressions. The initialized field must not be copied.

func NewStatic

func NewStatic(b []byte) *Static

NewStatic buffer with len(b) as its capacity. It is initially empty (b is truncated).

func (*Static) Bytes

func (s *Static) Bytes() []byte

Bytes doesn't panic.

func (*Static) Cap

func (s *Static) Cap() int

Capacity of the static buffer.

func (*Static) Extend

func (s *Static) Extend(n int) []byte

Extend panics with ErrStaticSize if n bytes cannot be appended to the buffer.

func (*Static) PutByte

func (s *Static) PutByte(value byte)

PutByte panics with ErrStaticSize if the buffer is already full.

func (*Static) ResizeBytes

func (s *Static) ResizeBytes(n int) []byte

ResizeBytes panics with ErrStaticSize if n is larger than maximum buffer size.