table

Documentation

Index

• Constants
• type Format
  • func DetectFormat(formatName string) (Format, error)
• type Table
  • func New(name string, w io.Writer) *Table
  • func (t *Table) Append(row []string)
  • func (t *Table) AppendBulk(rows [][]string)
  • func (t *Table) Render() error
  • func (t *Table) SetFormat(f Format)
  • func (t *Table) SetHeader(columns []string)

Constants

const DefaultFormat = FormatTable

DefaultFormat is the default format for output. It is a table.

Types

type Format

type Format int

Format is the output format.

const (
	// FormatTable prints a table.
	FormatTable Format = iota
	// FormatJSON prints JSON.
	FormatJSON
)

func DetectFormat

func DetectFormat(formatName string) (Format, error)

DetectFormat detects a format from a string.

type Table

type Table struct {
	Name   string
	Format Format
	// contains filtered or unexported fields
}

Table creates an output table. Use the New constructor to ensure defaults are set properly.

func New

func New(name string, w io.Writer) *Table

New creates an instance of table.

func (*Table) Append

func (t *Table) Append(row []string)

Append appends a row to the table.

func (*Table) AppendBulk

func (t *Table) AppendBulk(rows [][]string)

AppendBulk appends multiple rows to the table.

func (*Table) Render

func (t *Table) Render() error

Render writes the output to the table's writer.

func (*Table) SetFormat

func (t *Table) SetFormat(f Format)

SetFormat sets sets the output format.

func (*Table) SetHeader

func (t *Table) SetHeader(columns []string)

SetHeader sets the header for the table.