report

type Hinted ¶

type Hinted struct {
	Err  error
	Hint string
}

Hinted pairs an error with a one-line remediation hint, rendered as a "→" line by output.ReportError. Lives here (a leaf package) so any layer can attach a hint without importing internal/output.

func (e Hinted) Error() string

func (e Hinted) Unwrap() error

type NopPhase ¶

type NopPhase struct{}

NopPhase is a Phase that renders nothing. Used by discard reporters.

func (NopPhase) Done(string)

func (NopPhase) Fail(error)

type Phase ¶

type Phase interface {
	Done(final string)
	Fail(err error)
}

Phase represents an in-flight operation that has measurable duration. Call exactly one of Done or Fail when it finishes; Done's argument is the completed-state message (e.g. "Installed foo"), Fail reports failure of the original label.

Phase is the durational half of the completion vocabulary shared by the pkg and catalog reporters; its instant counterpart is a reporter's Completed method. Use Phase for work long enough to surface progress, and Completed for an operation with no measurable duration (e.g. a directory removal). How either is presented is decided by the reporter implementation.