progress

package

v0.2.0-beta.1 Latest Latest Go to latest Published: Sep 28, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package progress shares the progress and cancellation of one long-running operation between the goroutine doing the work and whoever displays it.

This section is empty.

This section is empty.

func IsCanceled(err error) bool

IsCanceled reports whether err is a user abort rather than a real failure.

type Progress struct {
	Phase         string
	Done          int
	Total         int
	Indeterminate bool
}

Progress describes the current phase of a network operation.

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

Tracker safely shares progress between a tea.Cmd goroutine and the TUI.

func NewTracker(phase string) *Tracker

NewTracker creates an indeterminate tracker with the given initial phase.

func (t *Tracker) Cancel()

Cancel asks the running operation to stop. Already-finished work is kept.

func (t *Tracker) Canceled() bool

Canceled reports whether Cancel has been called.

func (t *Tracker) Context() context.Context

Context is canceled when the user aborts the operation.

func (t *Tracker) Finish()

Finish marks the tracked operation as complete.

func (t *Tracker) Inc()

Inc advances the completed counter by one.

func (t *Tracker) Set(phase string, done, total int, indeterminate bool)

Set replaces the current progress values.

func (t *Tracker) Snapshot() (Progress, bool)

Snapshot returns a consistent progress snapshot.