util

Documentation

Index

• func BuildString(version *Version) string
• func GOBDecode(b []byte, result interface{}) error
• func GOBEncode(v interface{}) ([]byte, error)
• func GetBuildTime(version *Version) *time.Time
• func VersionString(version *Version) string
• func VersionedBuildString(version *Version) string
• type CallerTree
  • func CallerPaths(pc uintptr, file string, line int, ok bool) *CallerTree
• type Version

Functions

func BuildString

func BuildString(version *Version) string

BuildString ...

func GOBDecode

func GOBDecode(b []byte, result interface{}) error

GOBDecode ...

func GOBEncode

func GOBEncode(v interface{}) ([]byte, error)

GOBEncode ...

func GetBuildTime

func GetBuildTime(version *Version) *time.Time

GetBuildTime ...

func VersionString

func VersionString(version *Version) string

VersionString ...

func VersionedBuildString

func VersionedBuildString(version *Version) string

VersionedBuildString ...

Types

type CallerTree

type CallerTree struct {
	DotPath          string
	DotDotPath       string
	DotDotDotPath    string
	DotDotDotDotPath string
}

CallerTree returns data that precomputes paths for convenience

func CallerPaths

func CallerPaths(pc uintptr, file string, line int, ok bool) *CallerTree

CallerPaths takes as input the results from calling runtime.Caller(0) and returns a data structure of current caller's path and a set of parent paths. In a Golang-standard project directory for this project, the following would be true:

paths := CallerPaths(pc, file, line, ok) strings.HasSuffix(paths.DotPath, "/github.com/bluest-eel/common/util") strings.HasSuffix(paths.DotDotPath, "/github.com/bluest-eel/common") strings.HasSuffix(paths.DotDotDotPath, "/github.com/bluest-eel") strings.HasSuffix(paths.DotDotDotDotPath, "/github.com")

type Version

type Version struct {
	Semantic   string     `json:"semantic"`
	BuildDate  string     `json:"build-date"`
	BuildTime  *time.Time `json:"build-time"`
	GitCommit  string     `json:"git-commit"`
	GitBranch  string     `json:"git-branch"`
	GitSummary string     `json:"git-summary"`
}

Version data