README
¶
stopwatch
A simply package for timing your code. The intention is to provide a simple, light-weight library for benchmarking specific bits of your code when need be.
Example
package main
import (
"fmt"
"github.com/bradhe/stopwatch"
)
func main() {
watch := stopwatch.Start()
// Do some work.
watch.Stop()
fmt.Printf("Milliseconds elapsed: %v\n", watch.Milliseconds())
}
Contributing
- Fork and fix/implement in a branch.
- Make sure tests pass.
- Make sure you've added new coverage.
- Submit a PR.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Watch ¶
type Watch interface {
fmt.Stringer
// Timer calls a callback with the currently-measured time. This is useful for
// deferring out of a function.
Timer(fn TimerFunc)
// Stops the watch based on the current wall-clock time.
Stop() Watch
// Starts the watch based on the current wall-clock time.
Start() Watch
// Milliseconds returns the elapsed duration in milliseconds.
Milliseconds() time.Duration
// Seconds returns the elapsed duration in seconds.
Seconds() time.Duration
// Minutes returns the elapsed duration in minutes.
Minutes() time.Duration
// Hours returns the elapsed duration in hours.
Hours() time.Duration
// Days returns the elapsed duration in days.
Days() time.Duration
}
Source Files
Click to show internal directories.
Click to hide internal directories.