io

Documentation

Index

• func ConfigDocsURL(docID, anchor string) string
• func Log() zerolog.Logger
• func PrintQuestion(question string)
• func ProcessUserInput(prompt string) string
• type Format
• type Logger
  • func NewLogger(format Format, background bool) *Logger
  • func (l *Logger) AsPlainText(exec func())
  • func (l *Logger) Debugf(msg string, args ...any)
  • func (l *Logger) Debugx(msg string, kv ...any)
  • func (l *Logger) Error(err error, msg string)
  • func (l *Logger) Errorf(msg string, args ...any)
  • func (l *Logger) Errorx(msg string, kv ...any)
  • func (l *Logger) FatalErr(err error)
  • func (l *Logger) Fatalf(msg string, args ...any)
  • func (l *Logger) Fatalx(msg string, kv ...any)
  • func (l *Logger) Infof(msg string, args ...any)
  • func (l *Logger) Infox(msg string, kv ...any)
  • func (l *Logger) PendingRead() bool
  • func (l *Logger) PlainTextInfo(msg string)
  • func (l *Logger) PlainTextSuccess(msg string)
  • func (l *Logger) ReadAllData() string
  • func (l *Logger) SetBackground(v bool)
  • func (l *Logger) SetLevel(level int)
  • func (l *Logger) Warnf(msg string, args ...any)
  • func (l *Logger) Warnx(msg string, kv ...any)
  • func (l *Logger) Write(p []byte) (n int, err error)
  • func (l *Logger) WriteStr(data string)
• type OutputFormat
• type StdErrWriter
  • func (w StdErrWriter) Write(p []byte) (n int, err error)
• type StdInReader
  • func (r StdInReader) Read(p []byte) (n int, err error)
• type StdOutWriter
  • func (w StdOutWriter) Write(p []byte) (n int, err error)

Functions

func ConfigDocsURL

func ConfigDocsURL(docID, anchor string) string

func Log

func Log() zerolog.Logger

func PrintQuestion

func PrintQuestion(question string)

func ProcessUserInput

func ProcessUserInput(prompt string) string

Types

type Format

type Format int

const (
	HumanReadable Format = iota
	Storage
)

type Logger

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

func NewLogger

func NewLogger(format Format, background bool) *Logger

func (*Logger) AsPlainText

func (l *Logger) AsPlainText(exec func())

func (*Logger) Debugf

func (l *Logger) Debugf(msg string, args ...any)

func (*Logger) Debugx

func (l *Logger) Debugx(msg string, kv ...any)

func (*Logger) Error

func (l *Logger) Error(err error, msg string)

func (*Logger) Errorf

func (l *Logger) Errorf(msg string, args ...any)

func (*Logger) Errorx

func (l *Logger) Errorx(msg string, kv ...any)

func (*Logger) FatalErr

func (l *Logger) FatalErr(err error)

func (*Logger) Fatalf

func (l *Logger) Fatalf(msg string, args ...any)

func (*Logger) Fatalx

func (l *Logger) Fatalx(msg string, kv ...any)

func (*Logger) Infof

func (l *Logger) Infof(msg string, args ...any)

func (*Logger) Infox

func (l *Logger) Infox(msg string, kv ...any)

func (*Logger) PendingRead

func (l *Logger) PendingRead() bool

PendingRead returns true if there is pending data to be read. This is useful for background loggers that need to be read in a loop before exiting.

func (*Logger) PlainTextInfo

func (l *Logger) PlainTextInfo(msg string)

func (*Logger) PlainTextSuccess

func (l *Logger) PlainTextSuccess(msg string)

func (*Logger) ReadAllData

func (l *Logger) ReadAllData() string

func (*Logger) SetBackground

func (l *Logger) SetBackground(v bool)

func (*Logger) SetLevel

func (l *Logger) SetLevel(level int)

func (*Logger) Warnf

func (l *Logger) Warnf(msg string, args ...any)

func (*Logger) Warnx

func (l *Logger) Warnx(msg string, kv ...any)

func (*Logger) Write

func (l *Logger) Write(p []byte) (n int, err error)

func (*Logger) WriteStr

func (l *Logger) WriteStr(data string)

type OutputFormat

type OutputFormat string

const (
	OutputFormatUnset      OutputFormat = ""
	OutputFormatJSON       OutputFormat = "json"
	OutputFormatPrettyJSON OutputFormat = "jsonp"
	OutputFormatYAML       OutputFormat = "yaml"
)

type StdErrWriter

type StdErrWriter struct {
	LogFields   []any
	Logger      *Logger
	AsPlainText bool
}

func (StdErrWriter) Write

func (w StdErrWriter) Write(p []byte) (n int, err error)

type StdInReader

type StdInReader struct{}

func (StdInReader) Read

func (r StdInReader) Read(p []byte) (n int, err error)

type StdOutWriter

type StdOutWriter struct {
	LogFields   []any
	Logger      *Logger
	AsPlainText bool
}

func (StdOutWriter) Write

func (w StdOutWriter) Write(p []byte) (n int, err error)