Merge pull request #187 from cloudstruct/docs/utils-package

docs: code docs for utils package

Author: agaffney

utils/cbor.go

@@ -5,6 +5,7 @@ import (
 	"github.com/fxamacker/cbor/v2"
 )
 
+// CborEncode encodes the provided data as CBOR using the correct mode
 func CborEncode(data interface{}) ([]byte, error) {
 	buf := bytes.NewBuffer(nil)
 	em, err := cbor.CoreDetEncOptions().EncMode()
@@ -16,6 +17,7 @@ func CborEncode(data interface{}) ([]byte, error) {
 	return buf.Bytes(), err
 }
 
+// CborDecode decodes the provided CBOR into the given destination
 func CborDecode(dataBytes []byte, dest interface{}) (int, error) {
 	data := bytes.NewReader(dataBytes)
 	dec := cbor.NewDecoder(data)

utils/debug.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 )
 
+// DumpCborStructure generates an indented string representing an arbitrary data structure for debugging purposes
 func DumpCborStructure(data interface{}, prefix string) string {
 	var ret bytes.Buffer
 	switch v := data.(type) {

utils/utils.go

@@ -0,0 +1,2 @@
+// Package utils provides random utility functions
+package utils