ui

Documentation

Index

• type UI
  • func NewEphemeralTerminalUI() UI
  • func NewLoggerUI() UI
  • func Select(verbose, quiet bool) (uis []UI)

Types

type UI

type UI interface {
	Setup(unsubscribe func() error) error
	partybus.Handler
	Teardown(force bool) error
}

func NewEphemeralTerminalUI

func NewEphemeralTerminalUI() UI

NewEphemeralTerminalUI writes all events to a TUI and writes the final report to the given writer.

func NewLoggerUI

func NewLoggerUI() UI

NewLoggerUI writes all events to the common application logger and writes the final report to the given writer.

func Select

func Select(verbose, quiet bool) (uis []UI)

Select is responsible for determining the specific UI function given select user option, the current platform config values, and environment status (such as a TTY being present). The first UI in the returned slice of UIs is intended to be used and the UIs that follow are meant to be attempted only in a fallback posture when there are environmental problems (e.g. cannot write to the terminal). A writer is provided to capture the output of the final SBOM report.