hud

Documentation

Index

• Constants
• func NewEditStatusLine(buildStatus buildStatus) rty.Component
• type EditStatusLineComponent
  • func (esl *EditStatusLineComponent) Render(w rty.Writer, width, height int) error
  • func (esl *EditStatusLineComponent) Size(availWidth, availHeight int) (int, int, error)
• type ExitAction
  • func NewExitAction(err error) ExitAction
  • func (ExitAction) Action()
• type FakeHud
  • func NewFakeHud() *FakeHud
  • func (h *FakeHud) Close()
  • func (h *FakeHud) OnChange(ctx context.Context, st store.RStore)
  • func (h *FakeHud) Refresh(ctx context.Context)
  • func (h *FakeHud) Run(ctx context.Context, dispatch func(action store.Action), ...) error
  • func (h *FakeHud) SetNarrationMessage(ctx context.Context, msg string) error
  • func (h *FakeHud) Update(v view.View, vs view.ViewState) error
  • func (h *FakeHud) WaitUntil(t testing.TB, ctx context.Context, msg string, isDone func(view.View) bool)
  • func (h *FakeHud) WaitUntilResource(t testing.TB, ctx context.Context, msg string, name model.ManifestName, ...)
• type HeadsUpDisplay
  • func NewDefaultHeadsUpDisplay(renderer *Renderer, webURL model.WebURL, analytics analytics.Analytics) (HeadsUpDisplay, error)
• type Hud
  • func (h *Hud) Close()
  • func (h *Hud) OnChange(ctx context.Context, st store.RStore)
  • func (h *Hud) Refresh(ctx context.Context) error
  • func (h *Hud) Run(ctx context.Context, dispatch func(action store.Action), ...) error
  • func (h *Hud) SetNarrationMessage(ctx context.Context, msg string) error
  • func (h *Hud) Update(v view.View, vs view.ViewState) error
• type Renderer
  • func NewRenderer(clock func() time.Time) *Renderer
  • func (r *Renderer) Render(v view.View, vs view.ViewState) error
  • func (r *Renderer) Reset()
  • func (r *Renderer) SetUp() (chan tcell.Event, error)
• type ResourceView
  • func NewResourceView(res view.Resource, rv view.ResourceViewState, triggerMode model.TriggerMode, ...) *ResourceView
  • func (v *ResourceView) Build() rty.Component
• type SetLogTimestampsAction
  • func (SetLogTimestampsAction) Action()
• type StartProfilingAction
  • func (StartProfilingAction) Action()
• type StopProfilingAction
  • func (StopProfilingAction) Action()
• type TabView
  • func NewTabView(v view.View, vState view.ViewState) *TabView
  • func (v *TabView) Build() rty.Component

Constants

const BuildDurCellMinWidth = 7

const BuildStatusCellMinWidth = 8

const DefaultRefreshInterval = 100 * time.Millisecond

The main loop ensures the HUD updates at least this often

const DeployCellMinWidth = 8

These widths are determined experimentally, to see what shows up in a typical UX.

const MaxInlineErrHeight = 6

Functions

func NewEditStatusLine

func NewEditStatusLine(buildStatus buildStatus) rty.Component

Types

type EditStatusLineComponent

type EditStatusLineComponent struct {
	// contains filtered or unexported fields
}

func (*EditStatusLineComponent) Render

func (esl *EditStatusLineComponent) Render(w rty.Writer, width, height int) error

func (*EditStatusLineComponent) Size

func (esl *EditStatusLineComponent) Size(availWidth, availHeight int) (int, int, error)

type ExitAction

type ExitAction struct {
	Err error
}

func NewExitAction

func NewExitAction(err error) ExitAction

func (ExitAction) Action

func (ExitAction) Action()

type FakeHud

type FakeHud struct {
	LastView view.View

	Canceled bool
	Closed   bool
	// contains filtered or unexported fields
}

func NewFakeHud

func NewFakeHud() *FakeHud

func (*FakeHud) Close

func (h *FakeHud) Close()

func (*FakeHud) OnChange

func (h *FakeHud) OnChange(ctx context.Context, st store.RStore)

func (*FakeHud) Refresh

func (h *FakeHud) Refresh(ctx context.Context)

func (*FakeHud) Run

func (h *FakeHud) Run(ctx context.Context, dispatch func(action store.Action), refreshInterval time.Duration) error

func (*FakeHud) SetNarrationMessage

func (h *FakeHud) SetNarrationMessage(ctx context.Context, msg string) error

func (*FakeHud) Update

func (h *FakeHud) Update(v view.View, vs view.ViewState) error

func (*FakeHud) WaitUntil

func (h *FakeHud) WaitUntil(t testing.TB, ctx context.Context, msg string, isDone func(view.View) bool)

func (*FakeHud) WaitUntilResource

func (h *FakeHud) WaitUntilResource(t testing.TB, ctx context.Context, msg string, name model.ManifestName, isDone func(view.Resource) bool)

type HeadsUpDisplay

type HeadsUpDisplay interface {
	store.Subscriber

	Run(ctx context.Context, dispatch func(action store.Action), refreshRate time.Duration) error
	Update(v view.View, vs view.ViewState) error
	Close()
	SetNarrationMessage(ctx context.Context, msg string) error
}

func NewDefaultHeadsUpDisplay

func NewDefaultHeadsUpDisplay(renderer *Renderer, webURL model.WebURL, analytics analytics.Analytics) (HeadsUpDisplay, error)

type Hud

type Hud struct {
	// contains filtered or unexported fields
}

func (*Hud) Close

func (h *Hud) Close()

func (*Hud) OnChange

func (h *Hud) OnChange(ctx context.Context, st store.RStore)

func (*Hud) Refresh

func (h *Hud) Refresh(ctx context.Context) error

func (*Hud) Run

func (h *Hud) Run(ctx context.Context, dispatch func(action store.Action), refreshRate time.Duration) error

func (*Hud) SetNarrationMessage

func (h *Hud) SetNarrationMessage(ctx context.Context, msg string) error

func (*Hud) Update

func (h *Hud) Update(v view.View, vs view.ViewState) error

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

func NewRenderer

func NewRenderer(clock func() time.Time) *Renderer

func (*Renderer) Render

func (r *Renderer) Render(v view.View, vs view.ViewState) error

func (*Renderer) Reset

func (r *Renderer) Reset()

func (*Renderer) SetUp

func (r *Renderer) SetUp() (chan tcell.Event, error)

type ResourceView

type ResourceView struct {
	// contains filtered or unexported fields
}

func NewResourceView

func NewResourceView(res view.Resource, rv view.ResourceViewState, triggerMode model.TriggerMode,
	selected bool, clock func() time.Time) *ResourceView

func (*ResourceView) Build

func (v *ResourceView) Build() rty.Component

type SetLogTimestampsAction

type SetLogTimestampsAction struct {
	Value bool
}

func (SetLogTimestampsAction) Action

func (SetLogTimestampsAction) Action()

type StartProfilingAction

type StartProfilingAction struct {
}

func (StartProfilingAction) Action

func (StartProfilingAction) Action()

type StopProfilingAction

type StopProfilingAction struct {
}

func (StopProfilingAction) Action

func (StopProfilingAction) Action()

type TabView

type TabView struct {
	// contains filtered or unexported fields
}

func NewTabView

func NewTabView(v view.View, vState view.ViewState) *TabView

func (*TabView) Build

func (v *TabView) Build() rty.Component