bit

Documentation

Index

• type Bit
• type Reader
  • func NewReader(buf *bufioutil.Buffer) *Reader
  • func (r *Reader) ReadBit() (Bit, error)
  • func (r *Reader) ReadBits(numBits int) (uint64, error)
  • func (r *Reader) ReadByte() (byte, error)
  • func (r *Reader) Reset()
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) Flush() error
  • func (w *Writer) Reset(writer io.Writer)
  • func (w *Writer) WriteBit(bit Bit) error
  • func (w *Writer) WriteBits(u uint64, numBits int) error
  • func (w *Writer) WriteByte(b byte) error

Types

type Bit

type Bit bool

A Bit is a zero or a one

const (
	// Zero is our exported type for '0' bits
	Zero Bit = false
	// One is our exported type for '1' bits
	One Bit = true
)

type Reader

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

Reader reads bits from buffer

func NewReader

func NewReader(buf *bufioutil.Buffer) *Reader

NewReader crate bit reader

func (*Reader) ReadBit

func (r *Reader) ReadBit() (Bit, error)

ReadBit reads a bit, if failure return error

func (*Reader) ReadBits

func (r *Reader) ReadBits(numBits int) (uint64, error)

ReadBits read number of bits

func (*Reader) ReadByte

func (r *Reader) ReadByte() (byte, error)

ReadByte reads a byte

func (*Reader) Reset

func (r *Reader) Reset()

Reset resets the reader to read from a new slice

type Writer

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

Writer writes bits to an io.Writer

func NewWriter

func NewWriter(w io.Writer) *Writer

NewWriter create bit writer

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes the currently in-process byte

func (*Writer) Reset

func (w *Writer) Reset(writer io.Writer)

Reset writes to a new writer

func (*Writer) WriteBit

func (w *Writer) WriteBit(bit Bit) error

WriteBit writes a bit value

func (*Writer) WriteBits

func (w *Writer) WriteBits(u uint64, numBits int) error

WriteBits writes number of bits

func (*Writer) WriteByte

func (w *Writer) WriteByte(b byte) error

WriteByte write a byte