debugger

Documentation

Index

• Constants
• func Run(ctx context.Context, binaryPath string, options ...Option) error
• func Start(ctx context.Context, binaryPath string, options ...Option) (err error)
• type Option
  • func Address(address string) Option
  • func BinaryArgs(args ...string) Option
  • func ClientRunHook(fn func()) Option
  • func DisconnectChannel(c chan struct{}) Option
  • func Listener(l net.Listener) Option
  • func ServerStartHook(fn func()) Option
  • func WorkingDir(path string) Option

Constants

const (
	// DefaultAddress defines the default debug server address.
	DefaultAddress = "127.0.0.1:30500"

	// DefaultWorkingDir defines the default directory to use as
	// working dir when running the app binary that will be debugged.
	DefaultWorkingDir = "."
)

Functions

func Run

func Run(ctx context.Context, binaryPath string, options ...Option) error

Run runs a debug client.

func Start

func Start(ctx context.Context, binaryPath string, options ...Option) (err error)

Start starts a debug server.

Types

type Option

type Option func(*debuggerOptions)

Option configures debugging.

func Address

func Address(address string) Option

Address sets the address for the debug server.

func BinaryArgs

func BinaryArgs(args ...string) Option

BinaryArgs sets command line argument for the new process.

func ClientRunHook

func ClientRunHook(fn func()) Option

ClientRunHook sets a function to be executed right before debug client is run.

func DisconnectChannel

func DisconnectChannel(c chan struct{}) Option

DisconnectChannel sets the channel used by the server to signal when the client disconnects.

func Listener

func Listener(l net.Listener) Option

Listener sets a custom listener to serve requests.

func ServerStartHook

func ServerStartHook(fn func()) Option

ServerStartHook sets a function to be executed right before debug server starts.

func WorkingDir

func WorkingDir(path string) Option

WorkingDir sets the working directory of the new process.