bit

README

bit

A simple library to work with bits in Go programming language.

This library allows to convert bytes to bits and bits to bytes.
Bits are stored in memory as separate objects.

The main purpose of this library is a tool for work with bits which allows to use bits as objects directly. It uses big amount of memory while it stores each separate bit as boolean value.

This library is recommended for usage only for small amounts of data.

Documentation

Index

• Constants
• func ConvertBitsToBytes(bits []Bit) (result []byte, bitsCount int)
• func ConvertByteBitsToByte(bits [BitsPerByte]Bit) (result byte)
• type Bit
  • func ConvertByteToBits(b byte) (result []Bit)
  • func ConvertBytesToBits(bytes []byte) (result []Bit)

Constants

const (
	One  = true
	Zero = false
)

const (
	ErrBitsCountMismatch = "Bits Count Mismatch"
	ErrBitsMismatch      = "Bits Mismatch"
	ErrBytesMismatch     = "Bytes Mismatch"
	ErrNullPointer       = "Null Pointer"
)

Errors.

const BitsPerByte = 8

const TestNameErrDelimiter = ":"

Functions

func ConvertBitsToBytes

func ConvertBitsToBytes(
	bits []Bit,
) (result []byte, bitsCount int)

ConvertBitsToBytes converts the Array of Bits into an Array of Bytes.

func ConvertByteBitsToByte

func ConvertByteBitsToByte(
	bits [BitsPerByte]Bit,
) (result byte)

ConvertByteBitsToByte converts the eight Bits into a Byte.

Types

type Bit

type Bit bool

func ConvertByteToBits

func ConvertByteToBits(
	b byte,
) (result []Bit)

ConvertByteToBits converts the Byte into an Array of Bits.

func ConvertBytesToBits

func ConvertBytesToBits(
	bytes []byte,
) (result []Bit)

ConvertBytesToBits converts the Array of Bytes into an Array of Bits.