output

Documentation

Index

• Constants
• Variables
• func DefaultJSON(w io.Writer, i interface{})
• func ListCSV(writer io.Writer, many []map[string]interface{}, keys []string, noHeader bool)
• func ListJSON(w io.Writer, maps []map[string]interface{}, keys []string)
• func ListTable(writer io.Writer, many []map[string]interface{}, keys []string, noHeader bool)
• func MetadataCSV(writer io.Writer, m map[string]interface{}, keys []string, noHeader bool)
• func MetadataJSON(w io.Writer, m map[string]interface{}, keys []string)
• func MetadataTable(writer io.Writer, m map[string]interface{}, keys []string)
• type ErrArgs
  • func (e ErrArgs) Error() string
• type ErrFlagFormatting
  • func (e ErrFlagFormatting) Error() string
• type ErrMissingFlag
  • func (e ErrMissingFlag) Error() string

Constants

const INDENT string = "  "

INDENT is the indentation passed to json.MarshalIndent

Variables

var ErrArgsFlagPrefix = "Argument error:"

ErrArgsFlagPrefix is the prefix for when a flag's argument is invalid.

var ErrFlagFormattingPrefix = "Invalid flag formatting:"

ErrFlagFormatting is the prefix for when a flag's format is invalid.

var ErrMissingFlagPrefix = "Missing flag:"

ErrMissingFlagPrefix is the prefix for when a required flag is missing.

Functions

func DefaultJSON

func DefaultJSON(w io.Writer, i interface{})

func ListCSV

func ListCSV(writer io.Writer, many []map[string]interface{}, keys []string, noHeader bool)

func ListJSON

func ListJSON(w io.Writer, maps []map[string]interface{}, keys []string)

func ListTable

func ListTable(writer io.Writer, many []map[string]interface{}, keys []string, noHeader bool)

ListTable writes a table composed of keys as the header with values from many

func MetadataCSV

func MetadataCSV(writer io.Writer, m map[string]interface{}, keys []string, noHeader bool)

func MetadataJSON

func MetadataJSON(w io.Writer, m map[string]interface{}, keys []string)

func MetadataTable

func MetadataTable(writer io.Writer, m map[string]interface{}, keys []string)

MetadataTable writes a table to the writer composed of keys on the left and the associated metadata on the right column from m

Types

type ErrArgs

type ErrArgs struct {
	Msg string
}

ErrArgs is used when a flag's arguments are invalid.

func (ErrArgs) Error

func (e ErrArgs) Error() string

type ErrFlagFormatting

type ErrFlagFormatting struct {
	Msg string
}

ErrFlagFormatting is used when a flag's format is invalid.

func (ErrFlagFormatting) Error

func (e ErrFlagFormatting) Error() string

type ErrMissingFlag

type ErrMissingFlag struct {
	Msg string
}

ErrMissingFlag is used when a user doesn't provide a required flag.

func (ErrMissingFlag) Error

func (e ErrMissingFlag) Error() string