buffer

Documentation

Index

• Variables
• type Buffer
  • func Containing(data []byte, max int) *Buffer
  • func New(min uint32, max uint32) *Buffer
  • func (b Buffer) Bytes() ([]byte, error)
  • func (b *Buffer) Close() error
  • func (b *Buffer) EnsureCapacity(l int) bool
  • func (b *Buffer) Error() error
  • func (b *Buffer) Len() int
  • func (b *Buffer) Max() int
  • func (b *Buffer) MustString() string
  • func (b Buffer) OKBytes() []byte
  • func (b *Buffer) Pad(padSize int) error
  • func (b *Buffer) Read(p []byte) (int, error)
  • func (b *Buffer) Release()
  • func (b *Buffer) Reset()
  • func (b *Buffer) Seek(offset int64, whence int) (int64, error)
  • func (b Buffer) SqliteBytes() ([]byte, error)
  • func (b *Buffer) String() (string, error)
  • func (b Buffer) TakeBytes(l int) ([]byte, error)
  • func (b *Buffer) Truncate(n int)
  • func (b *Buffer) UnsafeString() (string, error)
  • func (b *Buffer) Write(data []byte) (int, error)
  • func (b *Buffer) WriteByte(byte byte)
  • func (b *Buffer) WriteByteUnsafe(byte byte)
  • func (b *Buffer) WritePad(data []byte, padSize int) (int, error)
  • func (b *Buffer) WriteString(data string)
• type Config
• type Pool
  • func NewPool(count uint16, minSize uint32, maxSize uint32) Pool
  • func NewPoolFromConfig(config Config) Pool
  • func (p Pool) Checkout() *Buffer
  • func (p *Pool) CheckoutMax(maxSize uint32) *Buffer

Variables

var (
	ErrMaxSize = errors.New("code: 3005 - buffer maximum size")
	Empty      = new(Buffer)
)

Types

type Buffer

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

func Containing

func Containing(data []byte, max int) *Buffer

create a buffer that contains the specified data (mostly useful for tests)

func New

func New(min uint32, max uint32) *Buffer

func (Buffer) Bytes

func (b Buffer) Bytes() ([]byte, error)

func (*Buffer) Close

func (b *Buffer) Close() error

io.Closer

func (*Buffer) EnsureCapacity

func (b *Buffer) EnsureCapacity(l int) bool

func (*Buffer) Error

func (b *Buffer) Error() error

func (*Buffer) Len

func (b *Buffer) Len() int

func (*Buffer) Max

func (b *Buffer) Max() int

func (*Buffer) MustString

func (b *Buffer) MustString() string

func (Buffer) OKBytes

func (b Buffer) OKBytes() []byte

func (*Buffer) Pad

func (b *Buffer) Pad(padSize int) error

ensure that we have enough space for padSize

func (*Buffer) Read

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

io.Reader

func (*Buffer) Release

func (b *Buffer) Release()

func (*Buffer) Reset

func (b *Buffer) Reset()

func (*Buffer) Seek

func (b *Buffer) Seek(offset int64, whence int) (int64, error)

func (Buffer) SqliteBytes

func (b Buffer) SqliteBytes() ([]byte, error)

optimization for passing the result to the ExecTerminated method of sqlite.Conn.

func (*Buffer) String

func (b *Buffer) String() (string, error)

func (Buffer) TakeBytes

func (b Buffer) TakeBytes(l int) ([]byte, error)

An advanced function. Some code might want to manipulate a []byte directly while leveraging the pre-allocated nature of a pooled buffer. Importantly, the returned bytes are not cleared

func (*Buffer) Truncate

func (b *Buffer) Truncate(n int)

func (*Buffer) UnsafeString

func (b *Buffer) UnsafeString() (string, error)

func (*Buffer) Write

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

func (*Buffer) WriteByte

func (b *Buffer) WriteByte(byte byte)

func (*Buffer) WriteByteUnsafe

func (b *Buffer) WriteByteUnsafe(byte byte)

Our caller knows that there's enough space in data (probably because it used WritePad)

func (*Buffer) WritePad

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

Write and ensure enough capacity for len(data) + padSize Meant to be used with WriteByteUnsafe.

func (*Buffer) WriteString

func (b *Buffer) WriteString(data string)

type Config

type Config struct {
	Count uint16 `json:"count"`
	Min   uint32 `json:"min"`
	Max   uint32 `json:"max"`
}

type Pool

type Pool struct {
	*concurrent.Pool[*Buffer]
	// contains filtered or unexported fields
}

func NewPool

func NewPool(count uint16, minSize uint32, maxSize uint32) Pool

func NewPoolFromConfig

func NewPoolFromConfig(config Config) Pool

func (Pool) Checkout

func (p Pool) Checkout() *Buffer

func (*Pool) CheckoutMax

func (p *Pool) CheckoutMax(maxSize uint32) *Buffer