bitstring

Documentation

Overview

Package bitstring provides functions for operating on byte slices as if they are 0-indexed arrays of bits, packed 8 bits to a byte, LSB-first.

Index

• func BitAt(bitString []byte, idx int) (bool, error)
• func Decode(src string) ([]byte, error)
• func Encode(bitString []byte) (string, error)

Functions

func BitAt

func BitAt(bitString []byte, idx int) (bool, error)

BitAt returns the bit in the idx'th position (zero-indexed) in the given bitstring.

func Decode

func Decode(src string) ([]byte, error)

Decode decodes a compressed bitstring from a base64URL-encoded string.

func Encode

func Encode(bitString []byte) (string, error)

Encode gzips a bitstring and encodes it as a raw urlsafe base-64 string.