inspect

package

v0.0.0-...-8680cc4 Latest Latest Go to latest Published: Sep 11, 2023 License: Apache-2.0 Imports: 9 Imported by: 9

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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.

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

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

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

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

func (i *IndentedInspector) Flush() error

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

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

Inspect writes the raw element with an indented json format.

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

Inspector defines an interface to implement to process elements.

func NewIndentedInspector(outputStream io.Writer) Inspector

NewIndentedInspector generates a new IndentedInspector.

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

NewTemplateInspector creates a new inspector with a template.

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

NewTemplateInspectorFromString creates a new TemplateInspector from a string.

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

TemplateInspector uses a template to inspect elements.

func (i *TemplateInspector) Flush() error

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

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

Inspect executes the inspect template.