output

package

v4.2.3 Latest Latest Go to latest Published: May 10, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

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

Package output handles program output.

This section is empty.

This section is empty.

func JSONReader(i interface{}) io.Reader

JSONReader marshals i as JSON.

type Format interface {
	Output(io.Writer, io.Reader) error
}

Format is the output format interface.

type FormatArg interface {
	Arg(string) error
	Required() bool
}

FormatArg is an optional interface. If implemented by a formatter, it may receive an argument.

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

Formatter manages output formatting.

func New() *Formatter

New returns an output formatter instance.

func (f *Formatter) ConfigFlags(fs *pflag.FlagSet)

ConfigFlags sets up the CLI flags based on the configured formatters.

func (f *Formatter) OK() error

OK outputs the 'OK' indication.

func (f *Formatter) Output(r io.Reader) error

Output outputs to r.

func (f *Formatter) Register(name string, fmt Format)

Register registers an output formatter.

func (f *Formatter) UpdateResult(id, rev string) error

UpdateResult outputs the result of an update.

type FriendlyOutput interface {
	io.Reader
	Execute(io.Writer) error
}

FriendlyOutput produces friendly output.

func TemplateReader(tmpl string, data interface{}, r io.Reader) FriendlyOutput

TemplateReader ...

Path	Synopsis
friendly Package friendly produces friendly-formatted output.	Package friendly produces friendly-formatted output.
gotmpl Package gotmpl handles go template output.	Package gotmpl handles go template output.
json Package json produces JSON output.	Package json produces JSON output.
raw Package raw produces raw output.	Package raw produces raw output.
yaml Package yaml produces YAML output.	Package yaml produces YAML output.