clock

Documentation

Overview

Package clock provides a mockable wrapper for `time.Now()`.

Index

• func After(ctx context.Context, d time.Duration) <-chan time.Time
• func NewContext(ctx context.Context, c clock) context.Context
• func Now(ctx context.Context) time.Time
• type FakeClock
  • func NewFakeClock() *FakeClock
  • func (c *FakeClock) Advance(d time.Duration)
  • func (c *FakeClock) After(d time.Duration) <-chan time.Time
  • func (c *FakeClock) AfterCalledChan() <-chan struct{}
  • func (c *FakeClock) Now() time.Time

Functions

func After

func After(ctx context.Context, d time.Duration) <-chan time.Time

After returns time.After() or the equivalent for the clock associated with the given context.

func NewContext

func NewContext(ctx context.Context, c clock) context.Context

NewContext returns a new context with the given clock attached.

This should generally only be used in tests; production code should always use the real time.

func Now

func Now(ctx context.Context) time.Time

Now returns the current time for the clock associated with the given context, or the real current time if there is no clock associated with the context. Any code that needs to be tested with a mocked-out time should use `clock.Now()` instead of `time.Now()`.

Types

type FakeClock

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

FakeClock provides support for mocking the current time in tests.

func NewFakeClock

func NewFakeClock() *FakeClock

func (*FakeClock) Advance

func (c *FakeClock) Advance(d time.Duration)

func (*FakeClock) After

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

func (*FakeClock) AfterCalledChan

func (c *FakeClock) AfterCalledChan() <-chan struct{}

AfterCalledChan returns the channel to wait for the clock's timer to be set from a call to After().

func (*FakeClock) Now

func (c *FakeClock) Now() time.Time