printer

Documentation

Overview

Package printer provides utilities for printing standard structures from api in convenient formats

Index

• func MustRegisterOutputFormatFlags(cmd *cobra.Command, outputFormat, fieldSeparator, recordSeparator *string)
• type Format
• type Printer
  • func New(out io.Writer, format Format, fieldSeparator, recordSeparator string) (Printer, error)

Functions

func MustRegisterOutputFormatFlags

func MustRegisterOutputFormatFlags(
	cmd *cobra.Command,
	outputFormat, fieldSeparator, recordSeparator *string,
)

Types

type Format

type Format string

Format represents supported printing outputs

const (
	YAMLFormat Format = "yaml"
	JSONFormat Format = "json"
	CSVFormat  Format = "csv"
)

All supported output formats by a Printer

type Printer

type Printer interface {
	Print(interface{}) error
}

Printer represents generic printer for cli

func New

func New(out io.Writer, format Format, fieldSeparator, recordSeparator string) (Printer, error)

New returns an instance of a proper printer based on format parameter