debug

Documentation

Index

• func Module(ball *mud.Ball)
• type ModuleGraph
  • func (m ModuleGraph) Description() string
  • func (m ModuleGraph) GenerateSVG(writer http.ResponseWriter, request *http.Request)
  • func (m ModuleGraph) Handler(writer http.ResponseWriter, request *http.Request)
  • func (m ModuleGraph) Path() string
• type Wrapper
  • func NewWrapper(logger *zap.Logger, config debug.Config, extensions []debug.Extension) (Wrapper, error)
  • func (d Wrapper) Close(ctx context.Context) error
  • func (d Wrapper) Run(ctx context.Context) error

Functions

func Module

func Module(ball *mud.Ball)

Module is a mud module definition.

Types

type ModuleGraph

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

ModuleGraph is a debug extension to visualize the module graph.

func (ModuleGraph) Description

func (m ModuleGraph) Description() string

Description implements the debug.Extension interface.

func (ModuleGraph) GenerateSVG

func (m ModuleGraph) GenerateSVG(writer http.ResponseWriter, request *http.Request)

GenerateSVG generates a SVG representation of the module (sub) graph.

func (ModuleGraph) Handler

func (m ModuleGraph) Handler(writer http.ResponseWriter, request *http.Request)

Handler is the HTTP handler for the module graph.

func (ModuleGraph) Path

func (m ModuleGraph) Path() string

Path implements the debug.Extension interface.

type Wrapper

type Wrapper struct {
	Listener net.Listener
	Server   *debug.Server
}

Wrapper combines the debug server and the listener.

func NewWrapper

func NewWrapper(logger *zap.Logger, config debug.Config, extensions []debug.Extension) (Wrapper, error)

NewWrapper creates a new debug server and listener.

func (Wrapper) Close

func (d Wrapper) Close(ctx context.Context) error

Close stops the debug server.

func (Wrapper) Run

func (d Wrapper) Run(ctx context.Context) error

Run starts the debug server.