mrerr

Documentation

Index

• Constants
• Variables
• type AppError
  • func Cast(proto *ProtoAppError) *AppError
  • func WithoutStackTrace(err *AppError) *AppError
  • func (e *AppError) Code() string
  • func (e *AppError) Error() string
  • func (e *AppError) InstanceID() string
  • func (e *AppError) Is(err error) bool
  • func (e *AppError) Kind() ErrorKind
  • func (e *AppError) Translate(t translator) mrmsg.ErrorMessage
  • func (e *AppError) Unwrap() error
  • func (e *AppError) WithAttr(name string, value any) *AppError
• type CustomError
  • func NewCustomError(customCode string, err error) *CustomError
  • func (e *CustomError) CustomCode() string
  • func (e *CustomError) Err() *AppError
  • func (e *CustomError) Error() string
  • func (e *CustomError) IsValid() bool
• type CustomErrors
  • func (l CustomErrors) Error() string
• type ErrorKind
  • func (k ErrorKind) String() string
• type ProtoAppError
  • func NewProto(code string, kind ErrorKind, message string) *ProtoAppError
  • func NewProtoWithExtra(code string, kind ErrorKind, message string, extra ProtoExtra) *ProtoAppError
  • func WithExtra(proto ProtoAppError, extra ProtoExtra) ProtoAppError
  • func (e *ProtoAppError) Code() string
  • func (e *ProtoAppError) Error() string
  • func (e *ProtoAppError) Is(err error) bool
  • func (e *ProtoAppError) Kind() ErrorKind
  • func (e *ProtoAppError) New(args ...any) *AppError
  • func (e *ProtoAppError) Translate(t translator) mrmsg.ErrorMessage
  • func (e *ProtoAppError) Wrap(err error, args ...any) *AppError
• type ProtoExtra
• type StackTracer

Constants

const (
	ErrorCodeUnexpectedInternal = "errUnexpectedInternal" // ErrorCodeUnexpectedInternal - обобщённый код ошибки: внутренняя ошибка приложения
	ErrorCodeUnexpectedSystem   = "errUnexpectedSystem"   // ErrorCodeUnexpectedSystem - обобщённый код ошибки: системная ошибка приложения
)

Variables

var (
	// ErrCustomErrorHasInternalError - пользовательская ошибка содержит внутреннюю или системную ошибку.
	ErrCustomErrorHasInternalError = NewProto(
		"errCustomErrorHasInternalError", ErrorKindInternal, "custom error has an internal error")

	// ErrCustomErrorHasNoWrappedError - пользовательская ошибка содержит необработанную ошибку.
	ErrCustomErrorHasNoWrappedError = NewProto(
		"errCustomErrorHasNoWrappedError", ErrorKindInternal, "custom error has no wrapped error")
)

var ErrErrorIsNilPointer = NewProto(
	"errErrorIsNilPointer", ErrorKindInternal, "specified error is nil")

ErrErrorIsNilPointer - указанная ошибка - nil pointer.

Types

type AppError

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

AppError - ошибка с поддержкой параметров, ID экземпляра ошибки и стека вызовов.

func Cast

func Cast(proto *ProtoAppError) *AppError

Cast - преобразует в ошибку AppError без вызова generateID и caller.

func WithoutStackTrace

func WithoutStackTrace(err *AppError) *AppError

WithoutStackTrace - возвращает ошибку без стека вызовов.

func (*AppError) Code

func (e *AppError) Code() string

Code - возвращает код ошибки.

func (*AppError) Error

func (e *AppError) Error() string

Error - возвращает ошибку в виде строки.

func (*AppError) InstanceID

func (e *AppError) InstanceID() string

InstanceID - возвращает уникальный идентификатор случившейся ошибки. Но только если в фабрике, породившей эту ошибку, был установлен генератор ID ошибок, В противном случае вернётся пустая строка.

func (*AppError) Is

func (e *AppError) Is(err error) bool

Is - проверяется что ошибка с указанным кодом (для возможности использования errors.Is).

func (*AppError) Kind

func (e *AppError) Kind() ErrorKind

Kind - возвращает тип ошибки.

func (*AppError) Translate

func (e *AppError) Translate(t translator) mrmsg.ErrorMessage

Translate - возвращает сформированное сообщение предназначенное для пользователя.

func (*AppError) Unwrap

func (e *AppError) Unwrap() error

Unwrap - возвращает вложенную ошибку (errors.Is использует этот интерфейс).

func (*AppError) WithAttr

func (e *AppError) WithAttr(name string, value any) *AppError

WithAttr - возвращает новую ошибку с прикреплённым к нему именованным атрибутом.

type CustomError

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

CustomError - пользовательская ошибка с персональным кодом.

func NewCustomError

func NewCustomError(customCode string, err error) *CustomError

NewCustomError - создаёт объект CustomError, аргумент err должен содержать ошибку.

func (*CustomError) CustomCode

func (e *CustomError) CustomCode() string

CustomCode - возвращает персональный код ошибки.

func (*CustomError) Err

func (e *CustomError) Err() *AppError

Err - возвращает вложенную ошибку, привязанную к текущей ошибке.

func (*CustomError) Error

func (e *CustomError) Error() string

Error - возвращает ошибку в виде строки.

func (*CustomError) IsValid

func (e *CustomError) IsValid() bool

IsValid - возвращает true, если внутри содержится пользовательская ошибка, все остальные ошибки считаются невалидными, программисту необходимо позаботиться их обернуть в пользовательский вид ошибки.

type CustomErrors

type CustomErrors []*CustomError

CustomErrors - список пользовательских ошибок.

func (CustomErrors) Error

func (l CustomErrors) Error() string

Error - возвращает список ошибок в виде строки.

type ErrorKind

type ErrorKind int8

ErrorKind - вид ошибки.

const (
	ErrorKindInternal ErrorKind = iota // ErrorKindInternal - внутренняя ошибка приложения (например: обращение по nil указателю)
	ErrorKindSystem                    // ErrorKindSystem - системная ошибка приложения (например: проблемы с сетью, с доступом к файлу)
	ErrorKindUser                      // ErrorKindUser - пользовательская ошибка (например: значение указанного поля некорректно)
)

func (ErrorKind) String

func (k ErrorKind) String() string

String - возвращает вид ошибки в виде строки.

type ProtoAppError

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

ProtoAppError - прототип ошибки с поддержкой параметров, ID экземпляра ошибки и стека вызовов.

func NewProto

func NewProto(code string, kind ErrorKind, message string) *ProtoAppError

NewProto - создаёт объект ProtoAppError.

func NewProtoWithExtra

func NewProtoWithExtra(code string, kind ErrorKind, message string, extra ProtoExtra) *ProtoAppError

NewProtoWithExtra - создаёт объект ProtoAppError с дополнительными параметрами.

func WithExtra

func WithExtra(proto ProtoAppError, extra ProtoExtra) ProtoAppError

WithExtra - создаёт новую ProtoAppError на основе указанной с дополнительными параметрами.

func (*ProtoAppError) Code

func (e *ProtoAppError) Code() string

Code - возвращает код ошибки.

func (*ProtoAppError) Error

func (e *ProtoAppError) Error() string

Error - возвращает ошибку в виде строки.

func (*ProtoAppError) Is

func (e *ProtoAppError) Is(err error) bool

Is - проверяется что ошибка с указанным кодом (для возможности использования errors.Is).

func (*ProtoAppError) Kind

func (e *ProtoAppError) Kind() ErrorKind

Kind - возвращает тип ошибки.

func (*ProtoAppError) New

func (e *ProtoAppError) New(args ...any) *AppError

New - всегда создаёт новую копию текущего объекта, при этом вызываются функции caller и onCreated если они были установлены.

func (*ProtoAppError) Translate

func (e *ProtoAppError) Translate(t translator) mrmsg.ErrorMessage

Translate - возвращает сформированное сообщение предназначенное для пользователя.

func (*ProtoAppError) Wrap

func (e *ProtoAppError) Wrap(err error, args ...any) *AppError

Wrap - создаёт новую ошибку на основе прототипа и оборачивает в неё указанную. Если указанная ошибка типа AppError, то проверяется был ли у этой ошибки сгенерированы ID и стек, и если да, то у новой ошибки эти параметры не генерятся, даже если соответствующие генераторы установлены для этой ошибки.

type ProtoExtra

type ProtoExtra struct {
	Caller    func() StackTracer
	OnCreated func(err *AppError) (instanceID string)
}

ProtoExtra - дополнительные опции для создания ProtoAppError.

type StackTracer

type StackTracer interface {
	Count() int
	Item(index int) (name, file string, line int)
}

StackTracer - предоставляет доступ к стеку вызовов.