ide

Documentation

Overview

Package ide contains UI and state management code for the TUI rebuild debugger.

Index

• type Instance
  • func (in *Instance) Dead() bool
  • func (in *Instance) Kill()
  • func (in *Instance) Run(ctx context.Context)
  • func (in *Instance) Serving() bool
  • func (in *Instance) Wait(ctx context.Context) <-chan error
• type Rebuilder
  • func (rb *Rebuilder) Attach(ctx context.Context) error
  • func (rb *Rebuilder) Instance() *Instance
  • func (rb *Rebuilder) Kill()
  • func (rb *Rebuilder) Restart(ctx context.Context)
  • func (rb *Rebuilder) RunLocal(ctx context.Context, r firestore.Rebuild, opts RunLocalOpts)
• type RunLocalOpts
• type TuiApp
  • func NewTuiApp(ctx context.Context, fireClient *firestore.Client, ...) *TuiApp
  • func (t *TuiApp) Run() error

Types

type Instance

type Instance struct {
	ID string
	// contains filtered or unexported fields
}

Instance represents a single run of the rebuilder container.

func (*Instance) Dead

func (in *Instance) Dead() bool

Dead returns whether the Instance is dead.

func (*Instance) Kill

func (in *Instance) Kill()

Kill does a non-blocking shutdown of the Instance container.

func (*Instance) Run

func (in *Instance) Run(ctx context.Context)

Run triggers the startup of the Instance. Should only be called once to initialize an Instance.

func (*Instance) Serving

func (in *Instance) Serving() bool

Serving returns whether the Instance is serving.

func (*Instance) Wait

func (in *Instance) Wait(ctx context.Context) <-chan error

Wait provides a way of getting alerted when the Instance initialization is complete.

type Rebuilder

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

Rebuilder manages a local instance of the rebuilder docker container.

func (*Rebuilder) Attach

func (rb *Rebuilder) Attach(ctx context.Context) error

Attach opens a new tmux window that's attached to the rebuilder container.

func (*Rebuilder) Instance

func (rb *Rebuilder) Instance() *Instance

Instance returns the underlying rebuilder instance currently in use.

func (*Rebuilder) Kill

func (rb *Rebuilder) Kill()

Kill does a non-blocking shutdown of the rebuilder container.

func (*Rebuilder) Restart

func (rb *Rebuilder) Restart(ctx context.Context)

Restart restarts the rebuilder container.

func (*Rebuilder) RunLocal

func (rb *Rebuilder) RunLocal(ctx context.Context, r firestore.Rebuild, opts RunLocalOpts)

RunLocal runs the rebuilder for the given example.

type RunLocalOpts

type RunLocalOpts struct {
	Strategy *schema.StrategyOneOf
}

type TuiApp

type TuiApp struct {
	Ctx context.Context
	// contains filtered or unexported fields
}

TuiApp represents the entire IDE, containing UI widgets and worker processes.

func NewTuiApp

func NewTuiApp(ctx context.Context, fireClient *firestore.Client, firestoreOpts firestore.FetchRebuildOpts) *TuiApp

NewTuiApp creates a new tuiApp object.

func (*TuiApp) Run

func (t *TuiApp) Run() error

Run runs the underlying tview app.