bin

Documentation

Overview

Package bin enables you to represent binary formats.

Bin Tag

The 'bin' tag format is used to specify how arguments are converted to binary on a bit-by-bit level. Each output byte is space-seperated, and each byte can either be a literal hex value (starting with '0x'), or a bit sequence. The bit sequence can contain substitutions based on the tagged function's arguments 'a', 'b', 'c' or 'd'.

• a: will be replaced with the Nth bit of 'a' where N is the number of occurences of 'a' so far in the tag.

• [a000]: 'a' is the 1st argument and will be written here wrapped as a 3bit value (the number of zeros determines the number of bits written).

• [a>n]: 'a' is the 1st argument and a 1 will be written here if the value of 'a' is greater than n, otherwise a 0 will be written. n can be any integer.

Index

• type Format
• type Writer
  • func NewWriter[Encoder Format]() Writer[Encoder]
  • func (src *Writer[T]) Bytes() []byte

Types

type Format

type Format interface {
	// contains filtered or unexported methods
}

Format should be embedded inside of an binary format.

type Writer

type Writer[Encoder Format] struct {
	Encoder *Encoder
	// contains filtered or unexported fields
}

Writer for a specific binary format.

func NewWriter

func NewWriter[Encoder Format]() Writer[Encoder]

NewWriter returns a new writer using the given assembly format.

func (*Writer[T]) Bytes

func (src *Writer[T]) Bytes() []byte