binstruct

Documentation

Overview

Package binstruct implements simple struct-tag-based conversion between Go structures and binary on-disk representations of that data.

Index

• func Marshal(obj any) ([]byte, error)
• func MarshalWithoutInterface(obj any) ([]byte, error)
• func StaticSize(obj any) int
• func Unmarshal(dat []byte, dstPtr any) (int, error)
• func UnmarshalWithoutInterface(dat []byte, dstPtr any) (int, error)
• type End
• type InvalidTypeError
  • func (e *InvalidTypeError) Error() string
  • func (e *InvalidTypeError) Unwrap() error
• type MarshalError
  • func (e *MarshalError) Error() string
  • func (e *MarshalError) Unwrap() error
• type Marshaler
• type StaticSizer
• type UnmarshalError
  • func (e *UnmarshalError) Error() string
  • func (e *UnmarshalError) Unwrap() error
• type Unmarshaler

Functions

func Marshal

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

func MarshalWithoutInterface

func MarshalWithoutInterface(obj any) ([]byte, error)

func StaticSize

func StaticSize(obj any) int

func Unmarshal

func Unmarshal(dat []byte, dstPtr any) (int, error)

func UnmarshalWithoutInterface

func UnmarshalWithoutInterface(dat []byte, dstPtr any) (int, error)

Types

type End

type End struct{}

type InvalidTypeError

type InvalidTypeError struct {
	Type reflect.Type
	Err  error
}

func (*InvalidTypeError) Error

func (e *InvalidTypeError) Error() string

func (*InvalidTypeError) Unwrap

func (e *InvalidTypeError) Unwrap() error

type MarshalError

type MarshalError struct {
	Type   reflect.Type
	Method string
	Err    error
}

func (*MarshalError) Error

func (e *MarshalError) Error() string

func (*MarshalError) Unwrap

func (e *MarshalError) Unwrap() error

type Marshaler

type Marshaler = encoding.BinaryMarshaler

type StaticSizer

type StaticSizer interface {
	BinaryStaticSize() int
}

type UnmarshalError

type UnmarshalError struct {
	Type   reflect.Type
	Method string
	Err    error
}

func (*UnmarshalError) Error

func (e *UnmarshalError) Error() string

func (*UnmarshalError) Unwrap

func (e *UnmarshalError) Unwrap() error

type Unmarshaler

type Unmarshaler interface {
	UnmarshalBinary([]byte) (int, error)
}