gather

Documentation

Overview

Package gather implements data structures storing binary data organized in a series of byte slices of fixed size that only gathered together by the user.

Index

• type Bytes
  • func FromSlice(b []byte) Bytes
  • func (b *Bytes) AppendSectionTo(output []byte, offset, size int) []byte
  • func (b Bytes) GetBytes(output []byte) []byte
  • func (b Bytes) Length() int
  • func (b Bytes) Reader() io.Reader
  • func (b Bytes) WriteTo(w io.Writer) (int64, error)
• type WriteBuffer
  • func NewWriteBuffer() *WriteBuffer
  • func (b *WriteBuffer) Append(data []byte)
  • func (b *WriteBuffer) AppendSectionTo(output []byte, offset, size int) []byte
  • func (b *WriteBuffer) Bytes() Bytes
  • func (b *WriteBuffer) Close()
  • func (b *WriteBuffer) GetBytes(output []byte) []byte
  • func (b *WriteBuffer) Length() int
  • func (b *WriteBuffer) Reset()
  • func (b *WriteBuffer) Write(data []byte) (n int, err error)

Types

type Bytes

type Bytes struct {
	Slices [][]byte
	// contains filtered or unexported fields
}

Bytes represents a sequence of bytes split into slices.

func FromSlice

func FromSlice(b []byte) Bytes

FromSlice creates Bytes from the specified slice.

func (*Bytes) AppendSectionTo

func (b *Bytes) AppendSectionTo(output []byte, offset, size int) []byte

AppendSectionTo appends the section of the buffer to the provided slice and returns it.

func (Bytes) GetBytes

func (b Bytes) GetBytes(output []byte) []byte

GetBytes appends all bytes to the provided slice and returns it.

func (Bytes) Length

func (b Bytes) Length() int

Length returns the combined length of all slices.

func (Bytes) Reader

func (b Bytes) Reader() io.Reader

Reader returns a reader for the data.

func (Bytes) WriteTo

func (b Bytes) WriteTo(w io.Writer) (int64, error)

WriteTo writes contents to the specified writer and returns number of bytes written.

type WriteBuffer

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

WriteBuffer is a write buffer for content of unknown size that manages data in a series of byte slices of uniform size.

func NewWriteBuffer

func NewWriteBuffer() *WriteBuffer

NewWriteBuffer creates new write buffer.

func (*WriteBuffer) Append

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

Append appends the specified slice of bytes to the buffer.

func (*WriteBuffer) AppendSectionTo

func (b *WriteBuffer) AppendSectionTo(output []byte, offset, size int) []byte

AppendSectionTo appends the section of the buffer to the provided slice and returns it.

func (*WriteBuffer) Bytes

func (b *WriteBuffer) Bytes() Bytes

Bytes returns inner gather.Bytes.

func (*WriteBuffer) Close

func (b *WriteBuffer) Close()

Close releases all memory allocated by this buffer.

func (*WriteBuffer) GetBytes

func (b *WriteBuffer) GetBytes(output []byte) []byte

GetBytes appends all bytes to the provided slice and returns it.

func (*WriteBuffer) Length

func (b *WriteBuffer) Length() int

Length returns the combined length of all slices.

func (*WriteBuffer) Reset

func (b *WriteBuffer) Reset()

Reset resets buffer back to empty.

func (*WriteBuffer) Write

func (b *WriteBuffer) Write(data []byte) (n int, err error)

Write implements io.Writer for appending to the buffer.