ui

Documentation

Index

• type View
  • func New(s *pb.UI_Settings) (View, error)

Types

type View

type View interface {
	io.Closer
	Settings() *pb.UI_Settings
	ShowError(err error) error
	ShowDiagnostics(diags []*pb.Diagnostic) error
	ShowVersion(all bool, res *pb.GetVersionResponse) error
	ShowFormat(cfg *pb.FormatRequest_Config, res *pb.FormatResponse) error
	ShowScenarioList(res *pb.ListScenariosResponse) error
	ShowScenarioOutline(res *pb.OutlineScenariosResponse) error
	ShowDecode(res *pb.DecodeResponse, incremental bool) error
	ShowOutput(res *pb.OperationResponses) error
	ShowScenariosValidateConfig(res *pb.ValidateScenariosConfigurationResponse) error
	ShowOperationEvent(res *pb.Operation_Event)
	ShowOperationResponse(res *pb.Operation_Response) error
	ShowOperationResponses(res *pb.OperationResponses) error
	ShowSampleList(res *pb.ListSamplesResponse) error
	ShowSampleObservation(res *pb.ObserveSampleResponse) error
}

View is a UI view. ShowX() methods are responsible for taking a command output response, displaying it appropriately, and exiting with an error if _any_ error diagnostics are present in the response.

func New

func New(s *pb.UI_Settings) (View, error)

New takes a UI configuration settings and returns a new view.