progress

package

v0.0.0-...-3f8eaf4 Latest Latest Go to latest Published: Apr 19, 2024 License: GPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package progress provides progress bars and progress reporting

This section is empty.

This section is empty.

func MakeChan() chan *ProgressMsg

type Event uint

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

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

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

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