bits

Documentation

Overview

Package bits contains functions to read/write bits from/to buffers.

Index

• func HasSpace(buf []byte, pos int, n int) error
• func ReadBits(buf []byte, pos *int, n int) (uint64, error)
• func ReadBitsUnsafe(buf []byte, pos *int, n int) uint64
• func ReadFlag(buf []byte, pos *int) (bool, error)
• func ReadFlagUnsafe(buf []byte, pos *int) bool
• func ReadGolombSigned(buf []byte, pos *int) (int32, error)
• func ReadGolombUnsigned(buf []byte, pos *int) (uint32, error)
• func WriteBits(buf []byte, pos *int, v uint64, n int)
• func WriteBitsUnsafe(buf []byte, pos *int, v uint64, n int)

Functions

func HasSpace

func HasSpace(buf []byte, pos int, n int) error

HasSpace checks whether buffer has space for N bits.

func ReadBits

func ReadBits(buf []byte, pos *int, n int) (uint64, error)

ReadBits reads N bits.

func ReadBitsUnsafe

func ReadBitsUnsafe(buf []byte, pos *int, n int) uint64

ReadBitsUnsafe reads N bits.

func ReadFlag

func ReadFlag(buf []byte, pos *int) (bool, error)

ReadFlag reads a boolean flag.

func ReadFlagUnsafe

func ReadFlagUnsafe(buf []byte, pos *int) bool

ReadFlagUnsafe reads a boolean flag.

func ReadGolombSigned

func ReadGolombSigned(buf []byte, pos *int) (int32, error)

ReadGolombSigned reads a signed golomb-encoded value.

func ReadGolombUnsigned

func ReadGolombUnsigned(buf []byte, pos *int) (uint32, error)

ReadGolombUnsigned reads an unsigned golomb-encoded value.

func WriteBits

func WriteBits(buf []byte, pos *int, v uint64, n int)

WriteBits writes N bits.

Deprecated: replaced by WriteBitsUnsafe.

func WriteBitsUnsafe

func WriteBitsUnsafe(buf []byte, pos *int, v uint64, n int)

WriteBitsUnsafe writes N bits.