canonicalizer

Documentation

Index

• func Canonicalize(obj interface{}, opts ...Option) ([]byte, error)
• func RegisterTemplate(o interface{})
• type Canonicalizer
• type Option
  • func OptionExcludeField(name string) Option

Functions

func Canonicalize

func Canonicalize(obj interface{}, opts ...Option) ([]byte, error)

Canonicalize returns hash-format representation of the data structure. Use the opts parameter for applying additional serialization options.

Nested types must implement Canonicalizer interface.

The implementation makes use of struct tags with the key 'hsh' as serialization template. Available options:

• 'idx' [mandatory]: binary serialization sequence for given field.
• 'size' [optional] : integer value size expressed in bytes. Supported values 1, 4, 8. If not set 1 is used as default.

e.g.

 type Object struct {
	    Number uint64 `hsh:"idx=1,size=8"`
	    Slice  []byte `hsh:"idx=2"`
 }

func RegisterTemplate

func RegisterTemplate(o interface{})

Types

type Canonicalizer

type Canonicalizer interface {
	Canonicalize() ([]byte, error)
}

Canonicalizer Interface for serializing data structures into deterministic hash-format.

type Option

type Option func(*serializeOptions) error

Option represent serialization optional parameters.

func OptionExcludeField

func OptionExcludeField(name string) Option

OptionExcludeField provides the ability for excluding fields from serialization.