reg

Documentation

Overview

Package reg is a registry for message types that implement the coding.Codec interface.

It is essentially a factory for messages, each registered message type has a function that returns a codec.Codec interface type containing the concrete type specified by the magic bytes.

It can either be used to manually generate a type as in the factory model, or is used as a recogniser, accepting a splice.Splice and returning the concrete type indicated by the magic prefix of the splice.

Index

• func MakeCodec(magic string) (cdc coding.Codec)
• func Recognise(s *splice.Splice) (cdc coding.Codec)
• func Register(magicString string, cdc func() coding.Codec)
• type CodecGenerators

Functions

func MakeCodec

func MakeCodec(magic string) (cdc coding.Codec)

func Recognise

func Recognise(s *splice.Splice) (cdc coding.Codec)

func Register

func Register(magicString string, cdc func() coding.Codec)

Types

type CodecGenerators

type CodecGenerators map[string]func() coding.Codec