progress

Documentation

Overview

Package progress provides progress bars and progress reporting

Index

• func MakeChan() chan *ProgressMsg
• type Event
• type ProgressMsg
• type ScanBar
  • func NewScanBar(want, freq, max uint64, widPct float64) *ScanBar
  • func (v *ScanBar) Pct() float64
  • func (v *ScanBar) Report(writer io.Writer, action, msg string)
  • func (v *ScanBar) Satisfied() bool

Functions

func MakeChan

func MakeChan() chan *ProgressMsg

Types

type Event

type Event uint

const (
	BeforeStart Event = iota
	Start
	Update
	Finished
	Error
	AllDone
	Cancelled
)

type ProgressMsg

type ProgressMsg struct {
	Event   Event
	Message string
	Error   error
	Payload interface{}
}

type ScanBar

type ScanBar struct {
	Visited uint64
	Found   uint64
	Wanted  uint64
	Max     uint64
	Freq    uint64
	WidPct  float64
}

func NewScanBar

func NewScanBar(want, freq, max uint64, widPct float64) *ScanBar

func (*ScanBar) Pct

func (v *ScanBar) Pct() float64

func (*ScanBar) Report

func (v *ScanBar) Report(writer io.Writer, action, msg string)

func (*ScanBar) Satisfied

func (v *ScanBar) Satisfied() bool