inspect

Documentation

Index

• func Inspect(out io.Writer, refs []string, tmplStr string, getRef GetRefFunc) error
• type GetRefFunc
• type IndentedInspector
  • func (i *IndentedInspector) Flush() error
  • func (i *IndentedInspector) Inspect(typedElement interface{}) error
• type Inspector
  • func NewIndentedInspector(outputStream io.Writer) Inspector
  • func NewTemplateInspector(out io.Writer, tmpl *template.Template) Inspector
  • func NewTemplateInspectorFromString(out io.Writer, tmplStr string) (Inspector, error)
• type TemplateInspector
  • func (i *TemplateInspector) Flush() error
  • func (i *TemplateInspector) Inspect(typedElement interface{}) error

Functions

func Inspect

func Inspect(out io.Writer, refs []string, tmplStr string, getRef GetRefFunc) error

Inspect fetches objects by reference and writes the json representation to the output writer.

Types

type GetRefFunc

type GetRefFunc func(ref string) (interface{}, error)

GetRefFunc is a function which used by Inspect to fetch an object from a reference

type IndentedInspector

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

IndentedInspector uses a buffer to stop the indented representation of an element.

func (*IndentedInspector) Flush

func (i *IndentedInspector) Flush() error

Flush writes the result of inspecting all elements into the output stream.

func (*IndentedInspector) Inspect

func (i *IndentedInspector) Inspect(typedElement interface{}) error

Inspect writes the raw element with an indented json format.

type Inspector

type Inspector interface {
	Inspect(typedElement interface{}) error
	Flush() error
}

Inspector defines an interface to implement to process elements.

func NewIndentedInspector

func NewIndentedInspector(outputStream io.Writer) Inspector

NewIndentedInspector generates a new IndentedInspector.

func NewTemplateInspector

func NewTemplateInspector(out io.Writer, tmpl *template.Template) Inspector

NewTemplateInspector creates a new inspector with a template.

func NewTemplateInspectorFromString

func NewTemplateInspectorFromString(out io.Writer, tmplStr string) (Inspector, error)

NewTemplateInspectorFromString creates a new TemplateInspector from a string.

type TemplateInspector

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

TemplateInspector uses a template to inspect elements.

func (*TemplateInspector) Flush

func (i *TemplateInspector) Flush() error

Flush writes the result of inspecting all elements into output stream.

func (*TemplateInspector) Inspect

func (i *TemplateInspector) Inspect(typedElement interface{}) error

Inspect executes the inspect template.