browseserver

Documentation

Overview

Package browseserver provides a web interface that can be used to interact with the vanadium debug interface.

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func CreateServeMux(ctx *context.T, timeout time.Duration, log bool, assetDir, urlPrefix string) (*http.ServeMux, error)
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func Serve(ctx *context.T, httpAddr, name string, timeout time.Duration, log bool, ...) error
• type Tracer
  • func (t *Tracer) String() string

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func CreateServeMux

func CreateServeMux(ctx *context.T, timeout time.Duration, log bool, assetDir, urlPrefix string) (*http.ServeMux, error)

CreateServeMux returns a ServeMux object that has handlers set up.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func Serve

func Serve(ctx *context.T, httpAddr, name string, timeout time.Duration, log bool, assetDir string) error

Serve serves the debug interface over http. An HTTP server is started (serving at httpAddr), its various handlers make rpc calls to the given name to gather debug information. If log is true we additionally log debug information for these rpc requests. Timeout defines the timeout for the rpc calls. The HTTPServer will run until the passed context is canceled.

Types

type Tracer

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

Tracer forces collection of a trace rooted at the call to newTracer.

func (*Tracer) String

func (t *Tracer) String() string