rerror

package

v0.0.0-...-5cbc45b Latest Latest Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 16 Imported by: 26

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/reearth/reearthx

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func As(err error, label error) error
func ErrIfNil[T any](t T, err error) (T, error)
func ErrInternalBy(err error) error
func ErrInternalByWith(label string, err error) error
func ErrInternalByWithContext(ctx context.Context, err error) error
func ErrInternalByWithContextAndError(ctx context.Context, label, err error) error
func ErrInternalByWithContextAndLabel(ctx context.Context, label string, err error) error
func ErrInternalByWithError(label, err error) error
func Is(err error, label error) bool
func IsInternal(err error) bool
func Localize(l *i18n.Localizer, err error) error
func OrInternal[T comparable](v T, err error) (r T, _ error)
func OrInternalWith[T comparable](ctx context.Context, v T, err error) (r T, _ error)
func PretifyStack(r io.Reader, w io.Writer)
func Stack() string
func UnwrapErrInternal(err error) error
func UnwrapErrInternalOr(err error) error
func With(label error) func(error) *Error
type E
- func FmtE(m *i18n.Message, args ...any) *E
- func NewE(m *i18n.Message) *E
- func WrapE(m *i18n.Message, err error) *E
- func (e *E) Error() string
- func (e *E) LocalizeError(l *i18n.Localizer) error
- func (e *E) Unwrap() error
type Error
- func Fmt(format string, a ...any) *Error
- func From(label string, err error) *Error
- func FromSep(label string, err error) *Error
- func Get(err error) *Error
- func (e *Error) Error() string
- func (e *Error) LocalizeError(l *i18n.Localizer) error
- func (e *Error) Unwrap() error
type Localizable
type Localizer
- func NewLocalizer(err error, l *i18n.Localizer) *Localizer
- func (l *Localizer) Error() string
type W
- func (w *W) Error() string
- func (w *W) Unwrap() error

Constants ¶

View Source

const (
	IDErrInternal       = "internal"
	IDErrNotFound       = "not found"
	IDErrAlreadyExists  = "already exists"
	IDErrInvalidParams  = "invalid params"
	IDErrNotImplemented = "not implemented"
)

Variables ¶

View Source

var (

	// ErrNotFound indicates something was not found.
	ErrNotFound = WrapE(&i18n.Message{ID: IDErrNotFound}, ErrNotFoundRaw)
	// ErrAlreadyExists indicates something was already exists.
	ErrAlreadyExists = WrapE(&i18n.Message{ID: IDErrAlreadyExists}, ErrAlreadyExistsRaw)
	// ErrInvalidParams represents the params are invalid, such as empty string.
	ErrInvalidParams = WrapE(&i18n.Message{ID: IDErrInvalidParams}, ErrInvalidParamsRaw)
	// ErrNotImplemented indicates unimplemented.
	ErrNotImplemented = WrapE(&i18n.Message{ID: IDErrNotImplemented}, ErrNotImplementedRaw)

	ErrNotFoundRaw       = errors.New("not found")
	ErrAlreadyExistsRaw  = errors.New("already exists")
	ErrInvalidParamsRaw  = errors.New("invalid params")
	ErrNotImplementedRaw = errors.New("not implemented")
)

Functions ¶

func As ¶

func As(err error, label error) error

As looks up errors whose label is the same as the specific label and return a wrapped error.

func ErrIfNil ¶

func ErrIfNil[T any](t T, err error) (T, error)

func ErrInternalBy ¶

func ErrInternalBy(err error) error

func ErrInternalByWith ¶

func ErrInternalByWith(label string, err error) error

func ErrInternalByWithContext ¶

func ErrInternalByWithContext(ctx context.Context, err error) error

func ErrInternalByWithContextAndError ¶

func ErrInternalByWithContextAndError(ctx context.Context, label, err error) error

func ErrInternalByWithContextAndLabel ¶

func ErrInternalByWithContextAndLabel(ctx context.Context, label string, err error) error

func ErrInternalByWithError ¶

func ErrInternalByWithError(label, err error) error

func Is ¶

func Is(err error, label error) bool

Is looks up errors whose label is the same as the specific label and return true if it was found

func IsInternal ¶

func IsInternal(err error) bool

func Localize ¶

func Localize(l *i18n.Localizer, err error) error

func OrInternal ¶

func OrInternal[T comparable](v T, err error) (r T, _ error)

func OrInternalWith ¶

func OrInternalWith[T comparable](ctx context.Context, v T, err error) (r T, _ error)

func PretifyStack ¶

func PretifyStack(r io.Reader, w io.Writer)

func Stack ¶

func Stack() string

func UnwrapErrInternal ¶

func UnwrapErrInternal(err error) error

func UnwrapErrInternalOr ¶

func UnwrapErrInternalOr(err error) error

func With ¶

func With(label error) func(error) *Error

With returns a new constructor to generate an Error with specific label.

Types ¶

type E ¶

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

func FmtE ¶

func FmtE(m *i18n.Message, args ...any) *E

func NewE ¶

func NewE(m *i18n.Message) *E

func WrapE ¶

func WrapE(m *i18n.Message, err error) *E

func (*E) Error ¶

func (e *E) Error() string

func (*E) LocalizeError ¶

func (e *E) LocalizeError(l *i18n.Localizer) error

func (*E) Unwrap ¶

func (e *E) Unwrap() error

type Error ¶

type Error struct {
	Label    error
	Err      error
	Hidden   bool
	Separate bool
}

Error can hold an error together with label. This is useful for displaying a hierarchical error message cleanly and searching by label later to retrieve a wrapped error. Currently, Go standard error library does not support these use cases. That's why we need our own error type.

func Fmt ¶

func Fmt(format string, a ...any) *Error

func From ¶

func From(label string, err error) *Error

From creates an Error with string label.

func FromSep ¶

func FromSep(label string, err error) *Error

From creates an Error with string label, but separated from wrapped error message when the error is printed.

func Get ¶

func Get(err error) *Error

Get gets Error struct from an error

func (*Error) Error ¶

func (e *Error) Error() string

Error implements error interface.

func (*Error) LocalizeError ¶

func (e *Error) LocalizeError(l *i18n.Localizer) error

func (*Error) Unwrap ¶

func (e *Error) Unwrap() error

Unwrap implements the interface for errors.Unwrap.

type Localizable ¶

type Localizable interface {
	LocalizeError(*i18n.Localizer) error
}

type Localizer ¶

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

func NewLocalizer ¶

func NewLocalizer(err error, l *i18n.Localizer) *Localizer

func (*Localizer) Error ¶

func (l *Localizer) Error() string

type W ¶

type W struct {
	Msg string
	Err error
}

W simply wraps an error, without printing it.

func (*W) Error ¶

func (w *W) Error() string

func (*W) Unwrap ¶

func (w *W) Unwrap() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL