topics

Documentation

Overview

Package topics defines several canonical ControlZ topics.

Index

• func ArgsTopic() fw.Topic
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func EnvTopic() fw.Topic
• func MemTopic() fw.Topic
• func MetricsTopic() fw.Topic
• func MustAsset(name string) []byte
• func NewCollectionTopic(title string, prefix string, collections ...ReadableCollection) fw.Topic
• func ProcTopic() fw.Topic
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func ScopeTopic() fw.Topic
• func VersionTopic() fw.Topic
• type ReadableCollection
  • func NewStaticCollection(name string, items map[string]interface{}) ReadableCollection

Functions

func ArgsTopic

func ArgsTopic() fw.Topic

ArgsTopic returns a ControlZ topic that allows visualization of process command-line arguments.

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 EnvTopic

func EnvTopic() fw.Topic

EnvTopic returns a ControlZ topic that allows visualization of process environment variables.

func MemTopic

func MemTopic() fw.Topic

MemTopic returns a ControlZ topic that allows visualization of process memory usage.

func MetricsTopic

func MetricsTopic() fw.Topic

MetricsTopic returns a ControlZ topic that allows visualization of process metrics.

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 NewCollectionTopic

func NewCollectionTopic(title string, prefix string, collections ...ReadableCollection) fw.Topic

NewCollectionTopic creates a new custom topic that exposes the provided collections.

func ProcTopic

func ProcTopic() fw.Topic

ProcTopic returns a ControlZ topic that allows visualization of process state.

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 ScopeTopic

func ScopeTopic() fw.Topic

ScopeTopic returns a ControlZ topic that allows visualization of process logging scopes.

func VersionTopic

func VersionTopic() fw.Topic

VersionTopic returns a ControlZ topic that allows visualization of versioning info.

Types

type ReadableCollection

type ReadableCollection interface {
	Name() string
	Keys() (keys []string, err error)
	Get(id string) (interface{}, error)
}

ReadableCollection is a staticCollection collection of entries to be exposed via CtrlZ.

func NewStaticCollection

func NewStaticCollection(name string, items map[string]interface{}) ReadableCollection

NewStaticCollection creates a static collection from the given set of items.