out

Documentation

Overview

Package out provides a mechanism for sending localized, stylized output to the console.

Package out provides a mechanism for sending localized, stylized output to the console.

Package out provides a mechanism for sending localized, stylized output to the console.

Index

• Constants
• Variables
• func DisplayError(msg string, err error)
• func Err(format string, a ...interface{})
• func ErrLn(format string, a ...interface{})
• func ErrT(st style.Enum, format string, a ...V)
• func Error(k reason.Kind, format string, a ...V)
• func FailureT(format string, a ...V)
• func FatalT(format string, a ...V)
• func Fmt(format string, a ...V) string
• func Infof(format string, a ...V)
• func Ln(format string, a ...interface{})
• func LogEntries(msg string, err error, entries map[string][]string)
• func SetErrFile(w fdWriter)
• func SetJSON(j bool)
• func SetOutFile(w fdWriter)
• func String(format string, a ...interface{})
• func SuccessT(format string, a ...V)
• func T(st style.Enum, format string, a ...V)
• func WarnReason(k reason.Kind, format string, a ...V)
• func WarningT(format string, a ...V)
• type V

Constants

const MaxLogEntries = 3

MaxLogEntries controls the number of log entries to show for each source

Variables

var (

	// OverrideEnv is the environment variable used to override color/emoji usage
	OverrideEnv = "MINIKUBE_IN_STYLE"
	// JSON is whether or not we should output stdout in JSON format. Set using SetJSON()
	JSON = false
)

Functions

func DisplayError

func DisplayError(msg string, err error)

DisplayError prints the error and displays the standard minikube error messaging

func Err

func Err(format string, a ...interface{})

Err writes a basic formatted string to stderr

func ErrLn

func ErrLn(format string, a ...interface{})

ErrLn writes a basic formatted string with a newline to stderr

func ErrT

func ErrT(st style.Enum, format string, a ...V)

ErrT writes a stylized and templated error message to stderr

func Error

func Error(k reason.Kind, format string, a ...V)

Error shows an an error reason

func FailureT

func FailureT(format string, a ...V)

FailureT is a shortcut for writing a templated failure message to stderr

func FatalT

func FatalT(format string, a ...V)

FatalT is a shortcut for writing a templated fatal message to stderr

func Fmt

func Fmt(format string, a ...V) string

Fmt applies formatting and translation

func Infof

func Infof(format string, a ...V)

Infof is used for informational logs (options, env variables, etc)

func Ln

func Ln(format string, a ...interface{})

Ln writes a basic formatted string with a newline to stdout

func LogEntries

func LogEntries(msg string, err error, entries map[string][]string)

LogEntries outputs an error along with any important log entries.

func SetErrFile

func SetErrFile(w fdWriter)

SetErrFile configures which writer error output goes to.

func SetJSON

func SetJSON(j bool)

SetJSON configures printing to STDOUT in JSON

func SetOutFile

func SetOutFile(w fdWriter)

SetOutFile configures which writer standard output goes to.

func String

func String(format string, a ...interface{})

String writes a basic formatted string to stdout

func SuccessT

func SuccessT(format string, a ...V)

SuccessT is a shortcut for writing a templated success message to stdout

func T

func T(st style.Enum, format string, a ...V)

T writes a stylized and templated message to stdout

func WarnReason

func WarnReason(k reason.Kind, format string, a ...V)

WarnReason shows a warning reason

func WarningT

func WarningT(format string, a ...V)

WarningT is a shortcut for writing a templated warning message to stderr

Types

type V

type V map[string]interface{}

V is a convenience wrapper for templating, it represents the variable key/value pair.