Categorygithub.com/dgryski/go-bitstream
modulepackage
0.0.0-20180413035011-3522498ce2c8
Repository: https://github.com/dgryski/go-bitstream.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
1
Dependents
69
Files
183 SLOC

# README

bitstream: read and write bits from io.Reader and io.Writer streams

Full package documentation available at: http://godoc.org/github.com/dgryski/go-bitstream

# Functions

NewReader returns a BitReader that returns a single bit at a time from 'r'.
NewWriter returns a BitWriter that buffers bits and write the resulting bytes to 'w'.

# Constants

One is our exported type for '1' bits.
Zero is our exported type for '0' bits.

# Structs

A BitReader reads bits from an io.Reader.
A BitWriter writes bits to an io.Writer.

# Type aliases

A Bit is a zero or a one.