timing

Documentation

Index

• Variables
• func JSON() (string, error)
• func Summary() string
• type TimedRun
  • func NewTimedRun() *TimedRun
  • func (tr *TimedRun) JSON() (string, error)
  • func (tr *TimedRun) Stop(t *Timer)
  • func (tr *TimedRun) Summary() string
• type Timer
  • func Start(category string) *Timer

Variables

var DefaultFormat = template.Must(template.New("").Parse("{{range $c, $t := .}}{{$c}}: {{$t}}\n{{end}}"))

DefaultFormat is a default format string used by Summary.

var DefaultRun = NewTimedRun()

DefaultRun is the default "singleton" TimedRun instance.

Functions

func JSON

func JSON() (string, error)

func Summary

func Summary() string

Summary outputs a summary of the DefaultTimedRun.

Types

type TimedRun

type TimedRun struct {
	// contains filtered or unexported fields
}

TimedRun provides a running store of how long is spent in each category.

func NewTimedRun

func NewTimedRun() *TimedRun

NewTimedRun returns an initialized TimedRun instance.

func (*TimedRun) JSON

func (tr *TimedRun) JSON() (string, error)

func (*TimedRun) Stop

func (tr *TimedRun) Stop(t *Timer)

Stop stops the specified timer and increments the time spent in that category.

func (*TimedRun) Summary

func (tr *TimedRun) Summary() string

Summary outputs a summary of the specified TimedRun.

type Timer

type Timer struct {
	// contains filtered or unexported fields
}

Timer represents a running timer.

func Start

func Start(category string) *Timer

Start starts a new Timer and returns it.