progress

Documentation

Index

• type Progress
  • func NewProgress(d time.Duration) *Progress
  • func (p *Progress) Done()
  • func (p *Progress) Report(s Stat)
  • func (p *Progress) Reset()
  • func (p *Progress) Start()
• type ProgressFunc
• type Stat
  • func (s *Stat) Add(other Stat)
  • func (s Stat) String() string

Types

type Progress

type Progress struct {
	OnStart  func()
	OnUpdate ProgressFunc
	OnDone   ProgressFunc
	// contains filtered or unexported fields
}

func NewProgress

func NewProgress(d time.Duration) *Progress

func (*Progress) Done

func (p *Progress) Done()

func (*Progress) Report

func (p *Progress) Report(s Stat)

Report adds the statistics from s to the current state and tries to report the accumulated statistics via the feedback channel.

func (*Progress) Reset

func (p *Progress) Reset()

Reset resets all statistic counters to zero.

func (*Progress) Start

func (p *Progress) Start()

Start resets and runs the progress reporter.

type ProgressFunc

type ProgressFunc func(s Stat, runtime time.Duration, ticker bool)

type Stat

type Stat struct {
	Items    uint64
	Bytes    uint64
	Storage  uint64
	Errors   bool
	ItemName []string
}

Stat

func (*Stat) Add

func (s *Stat) Add(other Stat)

Add accumulates other into s.

func (Stat) String

func (s Stat) String() string