bitbuffer

Documentation

Index

• Variables
• type BitBuffer
  • func NewBitBuffer() *BitBuffer
  • func NewBitBufferFromBytes(data []byte) *BitBuffer
  • func (bb *BitBuffer) Bytes() []byte
  • func (bb *BitBuffer) ReadBits(bitCount int) (byte, error)
  • func (bb *BitBuffer) ReadByte() (byte, error)
  • func (bb *BitBuffer) ReadInt(endian Endian, length int) (int64, error)
  • func (bb *BitBuffer) ReadStringLengthPrefixed(endian Endian, length int) (string, error)
  • func (bb *BitBuffer) ReadStringNullTerminated(paddedLength int) (string, error)
  • func (bb *BitBuffer) ReadUint(endian Endian, length int) (uint64, error)
  • func (bb *BitBuffer) WriteBits(bits byte, bitCount int) error
  • func (bb *BitBuffer) WriteByte(c byte) error
  • func (bb *BitBuffer) WriteInt(value int64, endian Endian, length int) error
  • func (bb *BitBuffer) WriteStringLengthPrefixed(data string, endian Endian, length int) error
  • func (bb *BitBuffer) WriteStringNullTerminated(data string, paddedLength int) error
  • func (bb *BitBuffer) WriteUint(value uint64, endian Endian, length int) error
• type Endian

Variables

var ErrorNotByteMultiple = errors.New("can not read a non byte multiple int")

var ErrorStringTooLarge = errors.New("string length exceeds capacity of length prefix")

var ErrorTooManyBitsInOperation = errors.New("bit buffer can only perform operations on 8 or fewer bits")

Types

type BitBuffer

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

func NewBitBuffer

func NewBitBuffer() *BitBuffer

func NewBitBufferFromBytes

func NewBitBufferFromBytes(data []byte) *BitBuffer

func (*BitBuffer) Bytes

func (bb *BitBuffer) Bytes() []byte

func (*BitBuffer) ReadBits

func (bb *BitBuffer) ReadBits(bitCount int) (byte, error)

func (*BitBuffer) ReadByte

func (bb *BitBuffer) ReadByte() (byte, error)

func (*BitBuffer) ReadInt

func (bb *BitBuffer) ReadInt(endian Endian, length int) (int64, error)

func (*BitBuffer) ReadStringLengthPrefixed

func (bb *BitBuffer) ReadStringLengthPrefixed(endian Endian, length int) (string, error)

func (*BitBuffer) ReadStringNullTerminated

func (bb *BitBuffer) ReadStringNullTerminated(paddedLength int) (string, error)

func (*BitBuffer) ReadUint

func (bb *BitBuffer) ReadUint(endian Endian, length int) (uint64, error)

func (*BitBuffer) WriteBits

func (bb *BitBuffer) WriteBits(bits byte, bitCount int) error

func (*BitBuffer) WriteByte

func (bb *BitBuffer) WriteByte(c byte) error

func (*BitBuffer) WriteInt

func (bb *BitBuffer) WriteInt(value int64, endian Endian, length int) error

func (*BitBuffer) WriteStringLengthPrefixed

func (bb *BitBuffer) WriteStringLengthPrefixed(data string, endian Endian, length int) error

func (*BitBuffer) WriteStringNullTerminated

func (bb *BitBuffer) WriteStringNullTerminated(data string, paddedLength int) error

func (*BitBuffer) WriteUint

func (bb *BitBuffer) WriteUint(value uint64, endian Endian, length int) error

type Endian

type Endian uint8

const (
	BigEndian    Endian = 0
	LittleEndian Endian = 1
)