package observeclock

Import Path
	go.pact.im/x/clock/observeclock (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 0 packages

Involved Source Files

	   #d observeclock.go
		Package observeclock provides a clock implementation that allows observing
		Schedule, Timer and Ticker method calls.

		The package is intended as an alternative to mockclock for simple cases when
		observing an event creation is enough to reach the desired state.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Clock (struct)
		Clock allows observing creation of new events on the underlying clock.Clock
		instance.

		Fields (total 4, in which 2 are exported)
			Clock *clock.Clock
			Clock.Scheduler clock.Scheduler
			/* 2 unexporteds ... *//* 2 unexporteds: */
			mu sync.Mutex
			xs []chan struct{}
		Methods (total 7, in which 5 are exported)
			( Clock) Now() time.Time
				Now returns the current local time.

				Unless the underlying Scheduler implements Timer, Now calls Timer with zero
				duration and uses C on the returned timer to wait for the current time.

			(*Clock) Observe() <-chan struct{}
				Observe returns a channel that is closed on Schedule, Timer and Ticker calls.

			(*Clock) Schedule(d time.Duration, f func(time.Time)) clock.Event
				Schedule implements the clock.Scheduler interface.

			(*Clock) Ticker(d time.Duration) clock.Ticker
				Ticker implements the clock.TickerScheduler interface.

			(*Clock) Timer(d time.Duration) clock.Timer
				Timer implements the clock.TimerScheduler interface.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*Clock) event()
				event triggers an observable event.

			( Clock) sched() clock.Scheduler
				sched returns the Scheduler implementation for this clock.

		Implements (at least 4, all are exported)
			*Clock : go.pact.im/x/clock.NowScheduler
			*Clock : go.pact.im/x/clock.Scheduler
			*Clock : go.pact.im/x/clock.TickerScheduler
			*Clock : go.pact.im/x/clock.TimerScheduler
		As Outputs Of (at least 2, both are exported)
			func New(s clock.Scheduler) *Clock
			func NewClock(c *clock.Clock) *Clock


Package-Level Functions (total 2, both are exported)

	 func New(s clock.Scheduler) *Clock
		New returns a new Clock that observes the given clock.Scheduler including
		optional interface method calls.

	 func NewClock(c *clock.Clock) *Clock
		NewClock returns a new Clock that observes the given clock.Clock.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)