hud

Documentation

Index

• Constants
• Variables
• func NewEditStatusLine(buildStatus buildStatus) rty.Component
• type DumpEngineStateAction
  • func (DumpEngineStateAction) Action()
• 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) OnChange(ctx context.Context, st store.RStore, _ store.ChangeSummary) error
  • func (h *FakeHud) Run(ctx context.Context, dispatch func(action store.Action), ...) 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 NewHud(renderer *Renderer, webURL model.WebURL, analytics *analytics.TiltAnalytics, ...) HeadsUpDisplay
• type Hud
  • func (h *Hud) Close()
  • func (h *Hud) OnChange(ctx context.Context, st store.RStore, _ store.ChangeSummary) error
  • func (h *Hud) Refresh(ctx context.Context)
  • func (h *Hud) Run(ctx context.Context, dispatch func(action store.Action), ...) error
  • func (h *Hud) SetNarrationMessage(ctx context.Context, msg string)
• type IncrementalPrinter
  • func NewIncrementalPrinter(stdout Stdout) *IncrementalPrinter
  • func (p *IncrementalPrinter) Print(lines []logstore.LogLine)
  • func (p *IncrementalPrinter) PrintNewline()
• type Renderer
  • func NewRenderer(clock func() time.Time) *Renderer
  • func (r *Renderer) RTY() rty.RTY
  • func (r *Renderer) Render(v view.View, vs view.ViewState)
  • func (r *Renderer) Reset()
  • func (r *Renderer) SetUp() (chan tcell.Event, error)
• type ResourceView
  • func NewResourceView(logReader logstore.Reader, res view.Resource, rv view.ResourceViewState, ...) *ResourceView
  • func (v *ResourceView) Build() rty.Component
• type Stdout
  • func ProvideStdout() Stdout
• type TabView
  • func NewTabView(v view.View, vState view.ViewState) *TabView
  • func (v *TabView) Build() rty.Component
• type TerminalStream
  • func NewTerminalStream(printer *IncrementalPrinter, store store.RStore) *TerminalStream
  • func (h *TerminalStream) OnChange(ctx context.Context, st store.RStore, _ store.ChangeSummary) error
  • func (h *TerminalStream) TearDown(ctx context.Context)

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

Variables

var WireSet = wire.NewSet(
	NewRenderer,
	NewHud,
	NewTerminalStream,
	ProvideStdout,
	NewIncrementalPrinter)

Functions

func NewEditStatusLine

func NewEditStatusLine(buildStatus buildStatus) rty.Component

Types

type DumpEngineStateAction

type DumpEngineStateAction struct {
}

func (DumpEngineStateAction) Action

func (DumpEngineStateAction) Action()

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) OnChange

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

func (*FakeHud) Run

func (h *FakeHud) Run(ctx context.Context, dispatch func(action store.Action), refreshInterval time.Duration) 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
}

func NewHud

func NewHud(renderer *Renderer, webURL model.WebURL, analytics *analytics.TiltAnalytics, openurl openurl.OpenURL) HeadsUpDisplay

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, _ store.ChangeSummary) error

func (*Hud) Refresh

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

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)

type IncrementalPrinter

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

func NewIncrementalPrinter

func NewIncrementalPrinter(stdout Stdout) *IncrementalPrinter

func (*IncrementalPrinter) Print

func (p *IncrementalPrinter) Print(lines []logstore.LogLine)

func (*IncrementalPrinter) PrintNewline

func (p *IncrementalPrinter) PrintNewline()

type Renderer

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

func NewRenderer

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

func (*Renderer) RTY

func (r *Renderer) RTY() rty.RTY

func (*Renderer) Render

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

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(logReader logstore.Reader, 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 Stdout

type Stdout io.Writer

func ProvideStdout

func ProvideStdout() Stdout

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

type TerminalStream

type TerminalStream struct {
	ProcessedLogs logstore.Checkpoint
	// contains filtered or unexported fields
}

func NewTerminalStream

func NewTerminalStream(printer *IncrementalPrinter, store store.RStore) *TerminalStream

func (*TerminalStream) OnChange

func (h *TerminalStream) OnChange(ctx context.Context, st store.RStore, _ store.ChangeSummary) error

func (*TerminalStream) TearDown

func (h *TerminalStream) TearDown(ctx context.Context)

TODO(nick): We should change this API so that TearDown gets the RStore one last time.