README
¶
Errutil
Библиотека для создания собственного типа реализующего интерфейс error. Позволят создавать, редактировать, объединять собственные ошибки.
Error trace
Основная идея заключается в том, чтобы дать возможность записать в ошибку весь её путь от самого начала возникновения, до завершения обработки текущего вызова.
В любой момент исполнения кода в ошибку можно добавить пользовательское сообщение, а так же сообщение для разработчика, которое может дополнить/заменить стек ошибки
TODO-шки
- Оптимизировать хранение ошибки
- Сделать ошибку потокобезопасной
Documentation
¶
Index ¶
- Constants
- Variables
- func Cause(err error) error
- func Code(err error) string
- func DevMessage(err error) string
- func DevMessages(err error) []string
- func Message(err error, defaultMessage ...string) string
- func Messages(err error) []string
- func New(message ...string) error
- func NewWithCode(code string, message ...string) error
- func NewWithCodef(code string, format string, args ...interface{}) error
- func Newf(format string, args ...interface{}) error
- func Stack(err error) string
- func WithCode(err error, code string) error
- func WithDevMessage(err error, msg ...string) error
- func WithDevMessagef(err error, format string, args ...interface{}) error
- func WithMessage(err error, msg ...string) error
- func WithMessagef(err error, format string, args ...interface{}) error
- func WithStack(err error) error
- type StackFrame
Constants ¶
const ( CodePanic string = "PANIC" CodeCritical string = "CRITICAL" CodeUser string = "USER" )
Variables ¶
var ( DefaultCode = CodeCritical DefaultUserMessage = "Упс, что-то пошло не так. Попробуйте позже..." )
var MaxStackTraceDepth = 50
MaxStackTraceDepth - максимальная глубина стека
var StackTraceAppPrefix = "github.com/kontora13-go"
StackTraceAppPrefix - префикс модуля, по которому определяется свойство InApp фрейма
Functions ¶
func DevMessage ¶
func DevMessages ¶
func NewWithCode ¶
NewWithCode - конструктор ошибки из списка строк с указанием кода ошибки
func NewWithCodef ¶
NewWithCodef - конструктор ошибки из форматной строки с параметрами с указанием кода ошибки
func WithDevMessage ¶
func WithDevMessagef ¶
func WithMessage ¶
func WithMessagef ¶
Types ¶
type StackFrame ¶
type StackFrame struct {
// Путь к файлу, содержащему этот ProgramCounter
File string `json:"file,omitempty"`
// Номер строки в этом файле
LineNumber int `json:"line_number,omitempty"`
// Имя функции, в котором произошёл этот вызов
Function string `json:"function,omitempty"`
// Package, содержащий эту функцию
Package string `json:"package,omitempty"`
InApp bool `json:"in_app,omitempty"`
PC uintptr `json:"pc,omitempty"`
}
StackFrame - структура для описания фрейма стека
func NewStackTrace ¶
func NewStackTrace(skip int) []StackFrame
NewStackTrace создает стектрейс []StackFrame с использованием runtime.Callers.
func StackTrace ¶
func StackTrace(err error) []StackFrame
func (*StackFrame) IsEmpty ¶
func (frame *StackFrame) IsEmpty() bool
IsEmpty возвращает признак заполненности фрейма
func (*StackFrame) SourceLine ¶
func (frame *StackFrame) SourceLine() (string, error)
SourceLine возвращает строку кода из исходного файла
func (*StackFrame) String ¶
func (frame *StackFrame) String() string
String возвращает фрейм стека, отформатированный так же, как это делает go в runtime/debug.Stack()
Source Files