hint

package

v0.8.17 Latest Latest Go to latest Published: Feb 11, 2026 License: MPL-2.0 Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

func Wrap(err error, firstHint string, extraHints ...string) error

Wrap wraps up an error with hints, to help display hints to a user about what might fix the problem.

func Wrapf(err error, hintf string, args ...any) error

Wrapf wraps an error with a single hint with formatting arguments.

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

Error is an error that includes hints to be displayed after the error.

func FromError(err error) *Error

FromError attempts to parse the given error's string to an *hint.Error.

func (e *Error) Error() string

Error implements [error] interface.

func (e *Error) Hint() string

Hint returns all hints in a single string separated by a new line.

func (e *Error) Message() string