error

type E ¶

type E struct {
	// Cause is the cause of the error, if any.
	Cause error
	// Short description of the error.
	Short string
	// Source is the source of the error, if any.
	Source *source
	// Long description of the error.
	Long string
	// Remediation is the remediation for the error, if any.
	Remediation string
}

E is an error type with diagnostic information. It is inspired by Terraform's Diagnostic type.

Unlike Diagnostic, E has no Severity field. That's because in testkit, whether it's an Error or a Warning depends on the context.

In testkit apps, you combine E with log.L and appropriate Level so that the error and diagnostic information are logged according to the log level configured at runtime.

func New(short string, opts ...Option) *E

func Wrap(err error, short string, opts ...Option) E

func (e E) Error() string

func (e *E) String() string

func (e E) Unwrap() error

type Option ¶

type Option func(*E)

func Cause(err error) Option

func Long(s string) Option

func Remediation(s string) Option

func Source(filePath string, lineNum int, lineText string) Option