progress

Documentation

Index

• type Counter
  • func NewCounter(interval time.Duration, total uint64, report Func) *Counter
  • func (c *Counter) Add(v uint64)
  • func (c *Counter) Done()
  • func (c *Counter) Get() (v, max uint64)
  • func (c *Counter) SetMax(max uint64)
• type Func
• type NoopPrinter
  • func (*NoopPrinter) E(_ string, _ ...interface{})
  • func (*NoopPrinter) NewCounter(_ string) *Counter
  • func (*NoopPrinter) P(_ string, _ ...interface{})
  • func (*NoopPrinter) S(_ string, _ ...interface{})
  • func (*NoopPrinter) V(_ string, _ ...interface{})
  • func (*NoopPrinter) VV(_ string, _ ...interface{})
• type Printer
• type TestPrinter
  • func NewTestPrinter(t testing.TB) *TestPrinter
  • func (p *TestPrinter) E(msg string, args ...interface{})
  • func (p *TestPrinter) NewCounter(_ string) *Counter
  • func (p *TestPrinter) P(msg string, args ...interface{})
  • func (p *TestPrinter) S(msg string, args ...interface{})
  • func (p *TestPrinter) V(msg string, args ...interface{})
  • func (p *TestPrinter) VV(msg string, args ...interface{})
• type UpdateFunc
• type Updater
  • func NewUpdater(interval time.Duration, report UpdateFunc) *Updater
  • func (c *Updater) Done()

Types

type Counter

type Counter struct {
	Updater
	// contains filtered or unexported fields
}

A Counter tracks a running count and controls a goroutine that passes its value periodically to a Func.

The Func is also called when SIGUSR1 (or SIGINFO, on BSD) is received.

func NewCounter

func NewCounter(interval time.Duration, total uint64, report Func) *Counter

NewCounter starts a new Counter.

func (*Counter) Add

func (c *Counter) Add(v uint64)

Add v to the Counter. This method is concurrency-safe.

func (*Counter) Done

func (c *Counter) Done()

func (*Counter) Get

func (c *Counter) Get() (v, max uint64)

Get returns the current value and the maximum of c. This method is concurrency-safe.

func (*Counter) SetMax

func (c *Counter) SetMax(max uint64)

SetMax sets the maximum expected counter value. This method is concurrency-safe.

type Func

type Func func(value uint64, total uint64, runtime time.Duration, final bool)

A Func is a callback for a Counter.

The final argument is true if Counter.Done has been called, which means that the current call will be the last.

type NoopPrinter

type NoopPrinter struct{}

NoopPrinter discards all messages

func (*NoopPrinter) E

func (*NoopPrinter) E(_ string, _ ...interface{})

func (*NoopPrinter) NewCounter

func (*NoopPrinter) NewCounter(_ string) *Counter

func (*NoopPrinter) P

func (*NoopPrinter) P(_ string, _ ...interface{})

func (*NoopPrinter) S

func (*NoopPrinter) S(_ string, _ ...interface{})

func (*NoopPrinter) V

func (*NoopPrinter) V(_ string, _ ...interface{})

func (*NoopPrinter) VV

func (*NoopPrinter) VV(_ string, _ ...interface{})

type Printer

type Printer interface {
	NewCounter(description string) *Counter

	// E prints to stderr
	E(msg string, args ...interface{})
	// S prints to stdout
	S(msg string, args ...interface{})
	// P prints to stdout unless quiet was passed
	P(msg string, args ...interface{})
	// V prints to stdout if verbose is set once
	V(msg string, args ...interface{})
	// VV prints to stdout if verbose is set twice
	VV(msg string, args ...interface{})
}

A Printer can can return a new counter or print messages at different log levels. It must be safe to call its methods from concurrent goroutines.

type TestPrinter

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

TestPrinter prints messages during testing

func NewTestPrinter

func NewTestPrinter(t testing.TB) *TestPrinter

func (*TestPrinter) E

func (p *TestPrinter) E(msg string, args ...interface{})

func (*TestPrinter) NewCounter

func (p *TestPrinter) NewCounter(_ string) *Counter

func (*TestPrinter) P

func (p *TestPrinter) P(msg string, args ...interface{})

func (*TestPrinter) S

func (p *TestPrinter) S(msg string, args ...interface{})

func (*TestPrinter) V

func (p *TestPrinter) V(msg string, args ...interface{})

func (*TestPrinter) VV

func (p *TestPrinter) VV(msg string, args ...interface{})

type UpdateFunc

type UpdateFunc func(runtime time.Duration, final bool)

An UpdateFunc is a callback for a (progress) Updater.

The final argument is true if Updater.Done has been called, which means that the current call will be the last.

type Updater

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

An Updater controls a goroutine that periodically calls an UpdateFunc.

The UpdateFunc is also called when SIGUSR1 (or SIGINFO, on BSD) is received.

func NewUpdater

func NewUpdater(interval time.Duration, report UpdateFunc) *Updater

NewUpdater starts a new Updater.

func (*Updater) Done

func (c *Updater) Done()

Done tells an Updater to stop and waits for it to report its final value. Later calls do nothing.