fmsg

Documentation

Overview

Package fmsg provides various functions for output messages.

Index

• func AsBaseError(err error, target **BaseError) bool
• func BeforeExit()
• func Load() bool
• func Prepare(prefix string)
• func PrintBaseError(err error, fallback string)
• func Resume() bool
• func Store(v bool)
• func Suspend() bool
• func Verbose(v ...any)
• func Verbosef(format string, v ...any)
• func WrapError(err error, a ...any) error
• func WrapErrorFunc(err error, f func(err error) string) error
• func WrapErrorSuffix(err error, a ...any) error
• type BaseError
  • func (e *BaseError) Error() string
  • func (e *BaseError) Message() string
  • func (e *BaseError) Unwrap() error
• type Output
  • func (Output) BeforeExit()
  • func (Output) IsVerbose() bool
  • func (Output) PrintBaseErr(err error, fallback string)
  • func (Output) Resume() bool
  • func (Output) Suspend()
  • func (Output) Verbose(v ...any)
  • func (Output) Verbosef(format string, v ...any)
  • func (Output) WrapErr(err error, a ...any) error

Functions

func AsBaseError

func AsBaseError(err error, target **BaseError) bool

func BeforeExit

func BeforeExit()

func Load

func Load() bool

func Prepare

func Prepare(prefix string)

Prepare configures the system logger for Suspend and Resume to take effect.

func PrintBaseError

func PrintBaseError(err error, fallback string)

func Resume

func Resume() bool

func Store

func Store(v bool)

func Suspend

func Suspend() bool

func Verbose

func Verbose(v ...any)

func Verbosef

func Verbosef(format string, v ...any)

func WrapError

func WrapError(err error, a ...any) error

WrapError wraps an error with a corresponding message.

func WrapErrorFunc

func WrapErrorFunc(err error, f func(err error) string) error

WrapErrorFunc wraps an error with a corresponding message returned by f.

func WrapErrorSuffix

func WrapErrorSuffix(err error, a ...any) error

WrapErrorSuffix wraps an error with a corresponding message with err at the end of the message.

Types

type BaseError

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

BaseError implements an error container with a user-facing message

func (*BaseError) Error

func (e *BaseError) Error() string

func (*BaseError) Message

func (e *BaseError) Message() string

Message returns a user-facing error message

func (*BaseError) Unwrap

func (e *BaseError) Unwrap() error

type Output

type Output struct{}

func (Output) BeforeExit

func (Output) BeforeExit()

func (Output) IsVerbose

func (Output) IsVerbose() bool

func (Output) PrintBaseErr

func (Output) PrintBaseErr(err error, fallback string)

func (Output) Resume

func (Output) Resume() bool

func (Output) Suspend

func (Output) Suspend()

func (Output) Verbose

func (Output) Verbose(v ...any)

func (Output) Verbosef

func (Output) Verbosef(format string, v ...any)

func (Output) WrapErr

func (Output) WrapErr(err error, a ...any) error