proton

README

proton

Serialization library for go

Documentation

Index

• func Generate(filePath string, msgs ...Msg)
• type Marshaller
• type Msg
  • func Message(msg any, ignoreFields ...string) Msg

Functions

func Generate

func Generate(filePath string, msgs ...Msg)

Generate generates proton methods for provided types and stores them in a file.

Types

type Marshaller

type Marshaller interface {
	Messages() []any
	ID(msg any) (uint64, error)
	Size(msg any) (uint64, error)
	Marshal(msg any, buf []byte) (uint64, uint64, error)
	Unmarshal(id uint64, buf []byte) (any, uint64, error)
	MakePatch(msgDst, msgSrc any, buf []byte) (uint64, uint64, error)
	ApplyPatch(msg any, buf []byte) (uint64, error)
}

Marshaller is the interface implemented by marshallers.

type Msg

type Msg struct {
	MsgType      reflect.Type
	IgnoreFields map[string]bool
}

Msg represents message to generate code for.

func Message

func Message(msg any, ignoreFields ...string) Msg

Message defines message to generate code for.