ui

Documentation

Index

• type ConsoleReporter
  • func NewConsoleReporter() *ConsoleReporter
  • func (c *ConsoleReporter) StartPhase(name string, total int64, isBytes bool) Phase
• type NoOpReporter
  • func NewNoOpReporter() *NoOpReporter
  • func (n *NoOpReporter) StartPhase(name string, total int64, isBytes bool) Phase
• type Phase
• type Reporter

Types

type ConsoleReporter

type ConsoleReporter struct{}

ConsoleReporter implements Reporter using go-pretty for console output.

func NewConsoleReporter

func NewConsoleReporter() *ConsoleReporter

func (*ConsoleReporter) StartPhase

func (c *ConsoleReporter) StartPhase(name string, total int64, isBytes bool) Phase

type NoOpReporter

type NoOpReporter struct{}

NoOpReporter implements Reporter doing nothing (for tests or silent mode).

func NewNoOpReporter

func NewNoOpReporter() *NoOpReporter

func (*NoOpReporter) StartPhase

func (n *NoOpReporter) StartPhase(name string, total int64, isBytes bool) Phase

type Phase

type Phase interface {
	Increment(n int64)
	Log(msg string)
	Done()
	Error()
}

Phase represents an active progress tracking phase.

type Reporter

type Reporter interface {
	// StartPhase starts a new progress tracking phase.
	// name: Description of the phase.
	// total: Total items/bytes to process. 0 for indeterminate.
	// isBytes: If true, units are bytes, otherwise count.
	StartPhase(name string, total int64, isBytes bool) Phase
}

Reporter defines the interface for progress reporting.