initialisation

Documentation

Index

• type InitData
  • func NewErrorInitData(err error) *InitData
  • func NewInitData(ctx context.Context, targetType string, targetNames ...string) *InitData
  • func (i *InitData) Cleanup(ctx context.Context)
  • func (i *InitData) Init(ctx context.Context, targetType string, args ...string)
  • func (i *InitData) RegisterExporters(exporters ...export.Exporter) error
• type InitResult
  • func (r *InitResult) AddMessage(messages ...string)
  • func (r *InitResult) AddWarnings(warnings ...string)
  • func (r *InitResult) DisplayMessages()
  • func (r *InitResult) HasMessages() bool
  • func (r *InitResult) Merge(other InitResult)

Types

type InitData

type InitData struct {
	Workspace       *workspace.Workspace
	WorkspaceEvents *dashboardworkspace.WorkspaceEvents
	Result          *InitResult

	ShutdownTelemetry func()
	ExportManager     *export.Manager
	Target            modconfig.ModTreeItem
	Args              map[string]*modconfig.QueryArgs
}

func NewErrorInitData

func NewErrorInitData(err error) *InitData

func NewInitData

func NewInitData(ctx context.Context, targetType string, targetNames ...string) *InitData

func (*InitData) Cleanup

func (i *InitData) Cleanup(ctx context.Context)

func (*InitData) Init

func (i *InitData) Init(ctx context.Context, targetType string, args ...string)

func (*InitData) RegisterExporters

func (i *InitData) RegisterExporters(exporters ...export.Exporter) error

type InitResult

type InitResult struct {
	error_helpers.ErrorAndWarnings
	Messages []string

	// allow overriding of the display functions
	DisplayMessage func(ctx context.Context, m string)
	DisplayWarning func(ctx context.Context, w string)
}

func (*InitResult) AddMessage

func (r *InitResult) AddMessage(messages ...string)

func (*InitResult) AddWarnings

func (r *InitResult) AddWarnings(warnings ...string)

func (*InitResult) DisplayMessages

func (r *InitResult) DisplayMessages()

func (*InitResult) HasMessages

func (r *InitResult) HasMessages() bool

func (*InitResult) Merge

func (r *InitResult) Merge(other InitResult)