zookie

Documentation

Overview

Package zookie converts integers to zookies and vice versa

Index

• Variables
• func Decode(encoded *core.Zookie) (*zookie.DecodedZookie, error)
• func DecodeRevision(encoded *core.Zookie) (decimal.Decimal, error)
• func Encode(decoded *zookie.DecodedZookie) (*core.Zookie, error)
• func NewFromRevision(revision decimal.Decimal) *core.Zookie

Variables

var ErrNilZookie = errors.New("zookie pointer was nil")

ErrNilZookie is returned as the base error when nil is provided as the zookie argument to Decode

Functions

func Decode

func Decode(encoded *core.Zookie) (*zookie.DecodedZookie, error)

Decode converts an encoded zookie to its decoded version.

func DecodeRevision

func DecodeRevision(encoded *core.Zookie) (decimal.Decimal, error)

DecodeRevision converts and extracts the revision from a zookie.

func Encode

func Encode(decoded *zookie.DecodedZookie) (*core.Zookie, error)

Encode converts a decoded zookie to its opaque version.

func NewFromRevision

func NewFromRevision(revision decimal.Decimal) *core.Zookie

NewFromRevision generates an encoded zookie from an integral revision.