bnry

Documentation

Overview

Package bnry provides simple functions for encoding and decoding values as binary.

Supported data types

The types that can be encoded and decoded are int*, uint* (excluding int and uint), float*, bool, string and slices of these types. Read and UnmarshalBinary expect pointers to these types, while Write and MarshalBinary expect non-pointers.

Index

• func MarshalBinary(vals ...any) []byte
• func Read(r io.ByteReader, vals ...any) error
• func UnmarshalBinary(data []byte, vals ...any) error
• func Write(w io.Writer, vals ...any) error
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) Write(vals ...any) error

Functions

func MarshalBinary

func MarshalBinary(vals ...any) []byte

MarshalBinary writes the given values to a byte slice. Values should be of any of the supported types. Panics if a value is of an unsupported type.

func Read

func Read(r io.ByteReader, vals ...any) error

Read reads and decodes binary data into the given values. Values should be pointers to any of the supported types. Panics if a value is of an unsupported type.

func UnmarshalBinary

func UnmarshalBinary(data []byte, vals ...any) error

UnmarshalBinary decodes binary data into the given values. Values should be pointers to any of the supported types. Panics if a value is of an unsupported type.

func Write

func Write(w io.Writer, vals ...any) error

Write writes the given values to the given writer. Values should be of any of the supported types. Panics if a value is of an unsupported type.

Types

type Writer

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

func NewWriter

func NewWriter(w io.Writer) *Writer

func (*Writer) Write

func (w *Writer) Write(vals ...any) error

Write writes the given values. Values should be of any of the supported types. Panics if a value is of an unsupported type.