output

Documentation

Index

• Variables
• func Filter(objects map[interface{}]interface{}, filterList []string) map[interface{}]interface{}
• type Ack
  • func (a *Ack) AddItem(section string, item string)
  • func (a *Ack) AddSection(name string, items []interface{})
  • func (a *Ack) InitSection(name string)
  • func (a *Ack) Print(writer io.Writer)
• type AckBinding
• type GoTmpl
  • func NewGoTmpl(objects map[interface{}]interface{}, format string, topLevelKeys bool) *GoTmpl
  • func (m *GoTmpl) Print(writer io.Writer)
• type JSON
  • func NewJSON(objects map[interface{}]interface{}, format string, topLevelKeys bool) *JSON
  • func (j *JSON) Print(writer io.Writer)
• type Output
  • func (o *Output) AddFlags(cmd *cobra.Command, defaultOutput string)
  • func (o *Output) ConfiguredOutputTypes() []string
  • func (o *Output) ConfiguredOutputTypesString() string
  • func (o *Output) Print(objects map[interface{}]interface{})
• type Table
  • func NewTable(headings []interface{}, rows [][]interface{}) *Table
  • func TableFromObjects(objects map[interface{}]interface{}, headings []string, ...) *Table
  • func (t *Table) AddHeadings(headings ...interface{})
  • func (t *Table) AddHeadingsS(headings ...string)
  • func (t *Table) AddRow(rowValues ...interface{})
  • func (t *Table) AddRowS(rowValues ...string)
  • func (t *Table) Print(writer io.Writer)
• type TableBinding
• type Type

Variables

var AllTypes = []Type{
	JSONType,
	GoTmplType,
	TableType,
	AckType,
}

Functions

func Filter

func Filter(objects map[interface{}]interface{}, filterList []string) map[interface{}]interface{}

Types

type Ack

type Ack struct {
	Sections     map[string][]interface{}
	SectionOrder []string
}

func (*Ack) AddItem

func (a *Ack) AddItem(section string, item string)

func (*Ack) AddSection

func (a *Ack) AddSection(name string, items []interface{})

func (*Ack) InitSection

func (a *Ack) InitSection(name string)

func (*Ack) Print

func (a *Ack) Print(writer io.Writer)

type AckBinding

type AckBinding func(map[interface{}]interface{}, *Ack)

type GoTmpl

type GoTmpl struct {
	Objects      map[interface{}]interface{}
	Format       string
	TopLevelKeys bool
}

func NewGoTmpl

func NewGoTmpl(objects map[interface{}]interface{}, format string, topLevelKeys bool) *GoTmpl

func (*GoTmpl) Print

func (m *GoTmpl) Print(writer io.Writer)

type JSON

type JSON struct {
	Objects      map[interface{}]interface{}
	Format       string
	TopLevelKeys bool
}

func NewJSON

func NewJSON(objects map[interface{}]interface{}, format string, topLevelKeys bool) *JSON

func (*JSON) Print

func (j *JSON) Print(writer io.Writer)

type Output

type Output struct {
	Type   string
	Filter []string
	Format string
	// TopLevelKeys is only used for json and gotmpl currently
	TopLevelKeys bool
	TableBinding *TableBinding
	AckBinding   AckBinding
}

func (*Output) AddFlags

func (o *Output) AddFlags(cmd *cobra.Command, defaultOutput string)

func (*Output) ConfiguredOutputTypes

func (o *Output) ConfiguredOutputTypes() []string

func (*Output) ConfiguredOutputTypesString

func (o *Output) ConfiguredOutputTypesString() string

func (*Output) Print

func (o *Output) Print(objects map[interface{}]interface{})

type Table

type Table struct {
	Headings []interface{}
	Rows     [][]interface{}
}

func NewTable

func NewTable(headings []interface{}, rows [][]interface{}) *Table

func TableFromObjects

func TableFromObjects(objects map[interface{}]interface{}, headings []string, processObjects func(map[interface{}]interface{}, *Table)) *Table

func (*Table) AddHeadings

func (t *Table) AddHeadings(headings ...interface{})

func (*Table) AddHeadingsS

func (t *Table) AddHeadingsS(headings ...string)

func (*Table) AddRow

func (t *Table) AddRow(rowValues ...interface{})

func (*Table) AddRowS

func (t *Table) AddRowS(rowValues ...string)

func (*Table) Print

func (t *Table) Print(writer io.Writer)

type TableBinding

type TableBinding struct {
	Headings       []string
	ProcessObjects func(map[interface{}]interface{}, *Table)
}

type Type

type Type string

Type.

const (
	JSONType   Type = "json"
	GoTmplType Type = "template"
	TableType  Type = "table"
	AckType    Type = "ack"
)

These are the different output types.