importreporter

Documentation

Index

• type Interface
  • func NewBar(name string, progress *mpb.Progress, done chan struct{}) Interface
  • func NewDiscard() Interface
  • func NewLog(name string, log logr.Logger, done chan struct{}) Interface

Types

type Interface

type Interface interface {
	// AddPending adds a number of pending steps
	AddPending(pending int)

	// Completed marks a number of steps as completed
	Completed(completed int)

	// Create creates a new Interface instance that is nested within the current one.
	// This is useful for reporting importreporter of a part of the operation.
	Create(name string) Interface
}

Interface is an interface for reporting the importreporter of an import operation.

func NewBar

func NewBar(
	name string,
	progress *mpb.Progress,
	done chan struct{},
) Interface

NewBar creates a new import reporter that displays an on-screen progress bar on the console.

func NewDiscard

func NewDiscard() Interface

NewDiscard creates a new import reporter that discards all updates.

func NewLog

func NewLog(
	name string,
	log logr.Logger,
	done chan struct{},
) Interface

NewLog creates a new import reporter using a log to report progress.