table

Documentation

Index

• Constants
• func ErrorAtLeastOneColumn() error
• func ErrorHeaderMinWidthGreaterThanMaxWidth(headerTitle string, minWidth int, maxWidth int) error
• func ErrorHeaderWiderThanMaxWidth(headerTitle string, maxWidth int) error
• func ErrorWrongNumberOfColumns(rowNumber int, actualCols int, expectedCols int) error
• type Header
• type KeyValuePairOpts
• type KeyValuePairs
  • func (kvs *KeyValuePairs) Add(key interface{}, value interface{})
  • func (kvs *KeyValuePairs) AddAll(kvs2 KeyValuePairs)
  • func (kvs KeyValuePairs) Print(options ...*KeyValuePairOpts)
  • func (kvs KeyValuePairs) String(options ...*KeyValuePairOpts) string
• type Opts
• type Table
  • func (t *Table) FindHeaderByTitle(title string) *Header
  • func (t *Table) Format(opts ...*Opts) (string, error)
  • func (t *Table) MustFormat(opts ...*Opts) string
  • func (t *Table) MustPrint(opts ...*Opts)

Constants

const (
	ErrAtLeastOneColumn                  = "table.at_least_one_column"
	ErrHeaderWiderThanMaxWidth           = "table.header_wider_than_max_width"
	ErrHeaderMinWidthGreaterThanMaxWidth = "table.header_min_width_greater_than_max_width"
	ErrWrongNumberOfColumns              = "table.wrong_number_of_columns"
)

Functions

func ErrorAtLeastOneColumn

func ErrorAtLeastOneColumn() error

func ErrorHeaderMinWidthGreaterThanMaxWidth

func ErrorHeaderMinWidthGreaterThanMaxWidth(headerTitle string, minWidth int, maxWidth int) error

func ErrorHeaderWiderThanMaxWidth

func ErrorHeaderWiderThanMaxWidth(headerTitle string, maxWidth int) error

func ErrorWrongNumberOfColumns

func ErrorWrongNumberOfColumns(rowNumber int, actualCols int, expectedCols int) error

Types

type Header

type Header struct {
	Title    string
	MaxWidth int // Max width of the text (not including spacing). Items that are longer will be truncated to less than MaxWidth to fit the ellipses. If 0 is provided, it defaults to no max.
	MinWidth int // Min width of the text (not including spacing)
	Hidden   bool
}

type KeyValuePairOpts

type KeyValuePairOpts struct {
	Delimiter     *string // default: ":"
	NumSpaces     *int    // default: 1
	RightJustify  *bool   // default: false
	BoldFirstLine *bool   // default: false
	BoldKeys      *bool   // default: false
}

type KeyValuePairs

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

func (*KeyValuePairs) Add

func (kvs *KeyValuePairs) Add(key interface{}, value interface{})

func (*KeyValuePairs) AddAll

func (kvs *KeyValuePairs) AddAll(kvs2 KeyValuePairs)

func (KeyValuePairs) Print

func (kvs KeyValuePairs) Print(options ...*KeyValuePairOpts)

func (KeyValuePairs) String

func (kvs KeyValuePairs) String(options ...*KeyValuePairOpts) string

type Opts

type Opts struct {
	Sort       *bool // default is true
	BoldHeader *bool // default is true
}

type Table

type Table struct {
	Headers []Header
	Rows    [][]interface{}
	Spacing int // Spacing between rows. If 0 is provided, it defaults to 3.
}

func (*Table) FindHeaderByTitle

func (t *Table) FindHeaderByTitle(title string) *Header

func (*Table) Format

func (t *Table) Format(opts ...*Opts) (string, error)

func (*Table) MustFormat

func (t *Table) MustFormat(opts ...*Opts) string

Return the error message as a string

func (*Table) MustPrint

func (t *Table) MustPrint(opts ...*Opts)

Prints the error message as a string (if there is an error)