binary

Documentation

Overview

Package binary extends Go standard library package encoding/binary to support arbitrary, variable-sized values. The Go standard library package encoding/binary provides encoding/decoding of fixed-size Go values or slices of same. This package extends support to arbitrary, variable-sized values by prefixing these values with their varint-encoded size, recursively. It expects the encoded type and decoded type to match exactly and makes no attempt to reconcile or check for any differences.

Index

• Variables
• func Marshal(v any) ([]byte, error)
• func Unmarshal(b []byte, v any) error
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v any) (err error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func NewStrictEncoder(w io.Writer) *Encoder
  • func (b *Encoder) Encode(v any) (err error)

Variables

var (
	LittleEndian  = binary.LittleEndian
	BigEndian     = binary.BigEndian
	DefaultEndian = LittleEndian
)

Functions

func Marshal

func Marshal(v any) ([]byte, error)

func Unmarshal

func Unmarshal(b []byte, v any) error

Types

type Decoder

type Decoder struct {
	Order binary.ByteOrder
	// contains filtered or unexported fields
}

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

func (*Decoder) Decode

func (d *Decoder) Decode(v any) (err error)

type Encoder

type Encoder struct {
	Order binary.ByteOrder
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

func NewStrictEncoder

func NewStrictEncoder(w io.Writer) *Encoder

NewStrictEncoder creates an encoder similar to NewEncoder, however if this encoder attempts to encode a struct and the struct has no encodable fields an error is returned whereas the encoder returned from NewEncoder will simply not write anything to `w`.

func (*Encoder) Encode

func (b *Encoder) Encode(v any) (err error)