perf

Documentation

Index

• type Dash
  • func (da Dash) HandleKey(k view.KeyEvent) bool
  • func (da *Dash) Note(name, mess string, args ...interface{})
  • func (da *Dash) Render(g view.Grid)
  • func (da *Dash) RenderSize() (wanted, needed point.Point)
• type Perf
  • func (perf *Perf) Close() error
  • func (perf *Perf) Err() error
  • func (perf *Perf) Init(name string, proc ecs.Proc)
  • func (perf *Perf) Process()
  • func (perf *Perf) Running() (should, are bool)
  • func (perf *Perf) Start()
  • func (perf *Perf) Stop()

Types

type Dash

type Dash struct {
	*Perf
	// contains filtered or unexported fields
}

Dash is a summary widget that can be triggered to show a perf dialog.

func (Dash) HandleKey

func (da Dash) HandleKey(k view.KeyEvent) bool

HandleKey handles key input for the perf dashboard.

func (*Dash) Note

func (da *Dash) Note(name, mess string, args ...interface{})

Note adds or updats an optional note in the dashboard.

func (*Dash) Render

func (da *Dash) Render(g view.Grid)

Render the dashboard.

func (*Dash) RenderSize

func (da *Dash) RenderSize() (wanted, needed point.Point)

RenderSize calculates the wanted/needed size render the dashboard.

type Perf

type Perf struct {
	ecs.Proc
	// contains filtered or unexported fields
}

Perf is an ecs.Proc that collects Perf data.

func (*Perf) Close

func (perf *Perf) Close() error

Close cleans up the profiler, returning any error.

func (*Perf) Err

func (perf *Perf) Err() error

Err return any profiling error encountered; if this is non-nil, then profiling will not start.

func (*Perf) Init

func (perf *Perf) Init(name string, proc ecs.Proc)

Init sets up the perf system, writing results into a timestamped directory with an optional name prefix.

func (*Perf) Process

func (perf *Perf) Process()

Process runs a round of the perf system.

func (*Perf) Running

func (perf *Perf) Running() (should, are bool)

Running returns whether profiling has been requested, and whether it actually active.

func (*Perf) Start

func (perf *Perf) Start()

Start requests profiling to start, this happens during the next Process round.

func (*Perf) Stop

func (perf *Perf) Stop()

Stop requests profiling to start, this happens during the next Process round.