zedtoken

Documentation

Overview

Package zedtoken converts decimal.Decimal to zedtoken and vice versa

Index

• Variables
• func Decode(encoded *v1.ZedToken) (*zedtoken.DecodedZedToken, error)
• func DecodeRevision(encoded *v1.ZedToken) (decimal.Decimal, error)
• func Encode(decoded *zedtoken.DecodedZedToken) (*v1.ZedToken, error)
• func NewFromRevision(revision decimal.Decimal) *v1.ZedToken

Variables

var ErrNilZedToken = errors.New("zedtoken pointer was nil")

ErrNilZedToken is returned as the base error when nil is provided as the zedtoken argument to Decode

Functions

func Decode

func Decode(encoded *v1.ZedToken) (*zedtoken.DecodedZedToken, error)

Decode converts an encoded zedtoken to its decoded version.

func DecodeRevision

func DecodeRevision(encoded *v1.ZedToken) (decimal.Decimal, error)

DecodeRevision converts and extracts the revision from a zedtoken or legacy zookie.

func Encode

func Encode(decoded *zedtoken.DecodedZedToken) (*v1.ZedToken, error)

Encode converts a decoded zedtoken to its opaque version.

func NewFromRevision

func NewFromRevision(revision decimal.Decimal) *v1.ZedToken

NewFromRevision generates an encoded zedtoken from an integral revision.