output

Documentation

Overview

Package output provides writers in different formats.

Index

• func CompleteOutputArg(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective)
• type JSON
  • func NewJSON(writer io.Writer) *JSON
  • func (j *JSON) Flush() error
  • func (j *JSON) WriteHeader(_ *meta.ResourceDefinition, withEvents bool) error
  • func (j *JSON) WriteResource(r resource.Resource, event state.EventType) error
• type JSONPath
  • func NewJSONPath(writer io.Writer, jsonPath *jsonpath.JSONPath) *JSONPath
  • func (j *JSONPath) Flush() error
  • func (j *JSONPath) WriteHeader(definition *meta.ResourceDefinition, withEvents bool) error
  • func (j *JSONPath) WriteResource(r resource.Resource, event state.EventType) error
• type Table
  • func NewTable() *Table
  • func (table *Table) Flush() error
  • func (table *Table) WriteHeader(definition *meta.ResourceDefinition, withEvents bool) error
  • func (table *Table) WriteResource(r resource.Resource, event state.EventType) error
• type Writer
  • func NewWriter(format string) (Writer, error)
• type YAML
  • func NewYAML() *YAML
  • func (y *YAML) Flush() error
  • func (y *YAML) WriteHeader(_ *meta.ResourceDefinition, withEvents bool) error
  • func (y *YAML) WriteResource(r resource.Resource, event state.EventType) error

Functions

func CompleteOutputArg

func CompleteOutputArg(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective)

CompleteOutputArg represents tab completion for `--output` argument.

Types

type JSON

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

JSON outputs resources in JSON format.

func NewJSON

func NewJSON(writer io.Writer) *JSON

NewJSON initializes JSON resource output.

func (*JSON) Flush

func (j *JSON) Flush() error

Flush implements output.Writer interface.

func (*JSON) WriteHeader

func (j *JSON) WriteHeader(_ *meta.ResourceDefinition, withEvents bool) error

WriteHeader implements output.Writer interface.

func (*JSON) WriteResource

func (j *JSON) WriteResource(r resource.Resource, event state.EventType) error

WriteResource implements output.Writer interface.

type JSONPath

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

JSONPath outputs resources in JSONPath format.

func NewJSONPath

func NewJSONPath(writer io.Writer, jsonPath *jsonpath.JSONPath) *JSONPath

NewJSONPath initializes JSONPath resource output.

func (*JSONPath) Flush

func (j *JSONPath) Flush() error

Flush implements output.Writer interface.

func (*JSONPath) WriteHeader

func (j *JSONPath) WriteHeader(definition *meta.ResourceDefinition, withEvents bool) error

WriteHeader implements output.Writer interface.

func (*JSONPath) WriteResource

func (j *JSONPath) WriteResource(r resource.Resource, event state.EventType) error

WriteResource implements output.Writer interface.

type Table

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

Table outputs resources in Table view.

func NewTable

func NewTable() *Table

NewTable initializes table resource output.

func (*Table) Flush

func (table *Table) Flush() error

Flush implements output.Writer interface.

func (*Table) WriteHeader

func (table *Table) WriteHeader(definition *meta.ResourceDefinition, withEvents bool) error

WriteHeader implements output.Writer interface.

func (*Table) WriteResource

func (table *Table) WriteResource(r resource.Resource, event state.EventType) error

WriteResource implements output.Writer interface.

type Writer

type Writer interface {
	WriteHeader(definition *meta.ResourceDefinition, withEvents bool) error
	WriteResource(r resource.Resource, event state.EventType) error
	Flush() error
}

Writer interface.

func NewWriter

func NewWriter(format string) (Writer, error)

NewWriter builds writer from type.

type YAML

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

YAML outputs resources in YAML format.

func NewYAML

func NewYAML() *YAML

NewYAML initializes YAML resource output.

func (*YAML) Flush

func (y *YAML) Flush() error

Flush implements output.Writer interface.

func (*YAML) WriteHeader

func (y *YAML) WriteHeader(_ *meta.ResourceDefinition, withEvents bool) error

WriteHeader implements output.Writer interface.

func (*YAML) WriteResource

func (y *YAML) WriteResource(r resource.Resource, event state.EventType) error

WriteResource implements output.Writer interface.