bitio

Documentation

Index

• Variables
• type ReadSeeker
  • func NewReadSeeker(r io.ReadSeeker) ReadSeeker
• type Reader
  • func NewReader(r io.Reader) Reader
• type Writer
  • func NewWriter(w io.Writer) Writer

Variables

var (
	ErrInvalidAlignment  = errors.New("invalid alignment")
	ErrDiscouragedReader = errors.New("discouraged reader implementation")
)

Types

type ReadSeeker

type ReadSeeker interface {
	Reader
	io.Seeker
}

func NewReadSeeker

func NewReadSeeker(r io.ReadSeeker) ReadSeeker

type Reader

type Reader interface {
	io.Reader

	// alignment:
	//  |-1-byte-block-|--------------|--------------|--------------|
	//  |<-offset->|<-------------------width---------------------->|
	ReadBits(width uint) (data []byte, err error)

	ReadBit() (bit bool, err error)
}

func NewReader

func NewReader(r io.Reader) Reader

type Writer

type Writer interface {
	io.Writer

	// alignment:
	//  |-1-byte-block-|--------------|--------------|--------------|
	//  |<-offset->|<-------------------width---------------------->|
	WriteBits(data []byte, width uint) error

	WriteBit(bit bool) error
}

func NewWriter

func NewWriter(w io.Writer) Writer