progress

package

v1.0.1 Latest Latest Go to latest Published: Oct 25, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func WindowDurationOption(dur time.Duration) func(*progressIndicator)

WindowDurationOption changes the time window size.

type Manager struct {
	syncutil.RWMutex
	// contains filtered or unexported fields
}

Manager is used to maintain the progresses we care about.

func NewManager() *Manager

NewManager creates a new Manager.

func (m *Manager) AddProgress(progress string, current, total float64, updateInterval time.Duration, opts ...Option) (exist bool)

AddProgress adds a progress into manager if it doesn't exist.

func (m *Manager) GetProgresses(filter func(p string) bool) []string

GetProgresses gets progresses according to the filter.

func (m *Manager) RemoveProgress(progress string) (exist bool)

RemoveProgress removes a progress from manager.

func (m *Manager) Reset()

Reset resets the progress manager.

func (m *Manager) Status(progressName string) (progress, leftSeconds, currentSpeed float64, err error)

Status returns the current progress status of a give name.

func (m *Manager) UpdateProgress(progress string, current, remaining float64, isInc bool, opts ...Option)

UpdateProgress updates the progress if it exists.

func (m *Manager) UpdateProgressTotal(progress string, total float64)

UpdateProgressTotal updates the total value of a progress if it exists.

type Option func(*progressIndicator)

Option is used to do some action for progressIndicator.