output

Documentation

Index

• Variables
• func WriteObject(obj interface{}, outputType Type, out io.Writer) error
• func WriteObjects(objs []interface{}, outputType Type, out io.Writer) error
• type Type
  • func (t *Type) AsStringPtr() *string
  • func (t Type) IsFormattedOutput() bool
  • func (t Type) Validate() error

Variables

var (
	ValidTypes = []Type{TypeYAML, TypeJSON}
)

Functions

func WriteObject

func WriteObject(obj interface{}, outputType Type, out io.Writer) error

func WriteObjects

func WriteObjects(objs []interface{}, outputType Type, out io.Writer) error

Types

type Type

type Type string

OutputType specifies the type of output a command produces

const (
	// StringValueType is used for parameter values that are provided as a string.
	TypeYAML Type = "yaml"

	// ArrayValueType is used for parameter values that described an array of values.
	TypeJSON Type = "json"

	InvalidOutputError = "invalid output format, only support 'yaml' or 'json' or empty"
)

func (*Type) AsStringPtr

func (t *Type) AsStringPtr() *string

func (Type) IsFormattedOutput

func (t Type) IsFormattedOutput() bool

func (Type) Validate

func (t Type) Validate() error