chrono

Documentation

Index

• type Chrono
  • func NewChrono() *Chrono
  • func (c *Chrono) Elapsed() time.Duration
  • func (c *Chrono) Start()
  • func (c *Chrono) StartContext(ctx context.Context) chan time.Duration
  • func (c *Chrono) StartDeferred() (func(), chan<- time.Duration)
• type Ticker
  • func NewTicker(interval time.Duration) *Ticker
  • func (t *Ticker) Tick(ctx context.Context, fn func())
  • func (t *Ticker) TickErr(ctx context.Context, fn func() error) <-chan error

Types

type Chrono

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

Chrono can be used to time things around various parts of the application

func NewChrono

func NewChrono() *Chrono

NewChrono creates a `time.Chrono`

func (*Chrono) Elapsed

func (c *Chrono) Elapsed() time.Duration

Elapsed gets the duration elapsed between the time the chronometer was initialised. This method does not reset the internal clock, unless `Chrono.Start` is called.

func (*Chrono) Start

func (c *Chrono) Start()

Start starts the chronometer normally

func (*Chrono) StartContext

func (c *Chrono) StartContext(ctx context.Context) chan time.Duration

StartContext starts the chronometer and ends it whenever the context is terminated returning the duration via a channel

func (*Chrono) StartDeferred

func (c *Chrono) StartDeferred() (func(), chan<- time.Duration)

StartDeferred starts the chronometer and ends it whenever the returned callback is invoked, returning the duration via a channel

type Ticker

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

func NewTicker

func NewTicker(interval time.Duration) *Ticker

func (*Ticker) Tick

func (t *Ticker) Tick(ctx context.Context, fn func())

func (*Ticker) TickErr

func (t *Ticker) TickErr(ctx context.Context, fn func() error) <-chan error