codec

README

Overview

Package codec contains a serializer with that you can serialize (and unserialize) go object of any type (including channels and functions) in runtime.

Install

go get -u github.com/URALINNOVATSIYA/codec

Usage

To serialize any value in binary data use function Serialize:

value := ... // a value to serialize

data := Serialize(value)

or use type Serializer:

value := ... // a value to serialize

serializer := NewSerializer(GetStructCodingMode())
data := serializer.Encode(value)

To unserialize binary data do as follows:

var data []byte = ... // serialized value

value, err := Unserialize(data)

or

var data []byte = ... // serialized value

unserializer := NewUnserializer(GetStructCodingMode())
value, err := unserializer.Decode(data)

Type registration

To correct recover a serialized value we need to create its type dynamically in runtime. For this, we must register type of value before its serialization and unserialization.

By default, serializer registers each encountered type automatically. It's enough for some cases, but somewhere it leads to violation of type registration order. To ensure fixed order of type registration we should register each type in out program before any serialization or unserialization.

We can do it as follows:

// register zero value of a type
RegisterTypeOf(map[string][]bool{})
RegisterTypeOf(struct{b bool; i int}{})

// or register type directly
v := [][]any{} 
RegisterType(reflect.TypeOf(v))

Note: RegisterType works for functions but cannot guarantee uniqueness of function value because function type does not have ant information about function name. To get full information you must register functions through RegisterTypeOf

You can also turn off automatic registration of types calling TurnOffTypeAutoRegistration

Custom serialization

To implement your own custom serialization a type must implements Serializable interface:

type Flag bool

func (f Flag) Serialize() []byte {
	if f {
		return []byte{1}
	}
	return []byte{0}
}

func (f Flag) Unserialize(data []byte) (any, error) {
	return data[0] == 1, nil
}

Note: methods of Serializable must relate to a type value, not to pointer to the value.

Documentation

Index

• Constants
• func GetRegisteredTypeNames() []string
• func GetStructCodingMode() int
• func RegisterType(t reflect.Type)
• func RegisterTypeOf(value any)
• func Serialize(value any, options ...int) []byte
• func SetStructCodingMode(mode int)
• func TurnOffTypeAutoRegistration()
• func TurnOnTypeAutoRegistration()
• func Unserialize(bytes []byte, options ...int) (any, error)
• type Serializable
• type Serializer
  • func NewSerializer(structCodingMode int) *Serializer
  • func (s *Serializer) Encode(value any) []byte
• type Unserializer
  • func NewUnserializer(structCodingMode int) *Unserializer
  • func (u *Unserializer) Decode(data []byte) (value any, err error)

Constants

const (
	StructCodingModeDefault = 0
	StructCodingModeIndex   = 1
	StructCodingModeName    = 2
)

Functions

func GetRegisteredTypeNames

func GetRegisteredTypeNames() []string

func GetStructCodingMode

func GetStructCodingMode() int

func RegisterType

func RegisterType(t reflect.Type)

func RegisterTypeOf

func RegisterTypeOf(value any)

func Serialize

func Serialize(value any, options ...int) []byte

func SetStructCodingMode

func SetStructCodingMode(mode int)

func TurnOffTypeAutoRegistration

func TurnOffTypeAutoRegistration()

func TurnOnTypeAutoRegistration

func TurnOnTypeAutoRegistration()

func Unserialize

func Unserialize(bytes []byte, options ...int) (any, error)

Types

type Serializable

type Serializable interface {
	Serialize() []byte
	Unserialize([]byte) (any, error)
}

type Serializer

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

func NewSerializer

func NewSerializer(structCodingMode int) *Serializer

func (*Serializer) Encode

func (s *Serializer) Encode(value any) []byte

type Unserializer

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

func NewUnserializer

func NewUnserializer(structCodingMode int) *Unserializer

func (*Unserializer) Decode

func (u *Unserializer) Decode(data []byte) (value any, err error)