ttime

Documentation

Overview

Package ttime implements a testable alternative to the Go "time" package.

Index

• func Now() time.Time
• func SetTime(t Time)
• func Since(t time.Time) time.Duration
• type DefaultTime
  • func (*DefaultTime) After(d time.Duration) <-chan time.Time
  • func (*DefaultTime) AfterFunc(d time.Duration, f func()) Timer
  • func (*DefaultTime) Now() time.Time
  • func (*DefaultTime) Sleep(d time.Duration)
• type Time
• type Timer

Functions

func Now

func Now() time.Time

Now returns the implementation's current time

func SetTime

func SetTime(t Time)

SetTime configures what 'Time' implementation to use for each of the package-level methods.

func Since

func Since(t time.Time) time.Duration

Since returns the time different from Now and the given time t

Types

type DefaultTime

type DefaultTime struct{}

DefaultTime is a Time that behaves normally

func (*DefaultTime) After

func (*DefaultTime) After(d time.Duration) <-chan time.Time

After sleeps for the given duration and then writes to to the returned channel

func (*DefaultTime) AfterFunc

func (*DefaultTime) AfterFunc(d time.Duration, f func()) Timer

AfterFunc waits for the duration to elapse and then calls f in its own goroutine. It returns a Timer that can be used to cancel the call using its Stop method.

func (*DefaultTime) Now

func (*DefaultTime) Now() time.Time

Now returns the current time

func (*DefaultTime) Sleep

func (*DefaultTime) Sleep(d time.Duration)

Sleep sleeps for the given duration

type Time

type Time interface {
	Now() time.Time
	Sleep(d time.Duration)
	After(d time.Duration) <-chan time.Time
	AfterFunc(d time.Duration, f func()) Timer
}

Time represents an implementation for this package's methods

type Timer

type Timer interface {
	Reset(d time.Duration) bool
	Stop() bool
}