statuserror

package
v0.0.0-...-58f8293 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2024 License: MIT Imports: 11 Imported by: 4

Documentation

Overview

Package statuserror GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func StatusCodeFromCode

func StatusCodeFromCode(code int) int

func Summary

func Summary(err error) (string, bool)

Types

type ErrorField

type ErrorField struct {
	// field path
	// prop.slice[2].a
	Field string `json:"field" xml:"field"`
	// msg
	Msg string `json:"msg" xml:"msg"`
	// location
	// eq. body, query, header, path, formData
	In string `json:"in" xml:"in"`
}

func NewErrorField

func NewErrorField(in string, field string, msg string) *ErrorField

func (ErrorField) RuntimeDoc

func (v ErrorField) RuntimeDoc(names ...string) ([]string, bool)

func (ErrorField) String

func (s ErrorField) String() string

type ErrorFields

type ErrorFields []*ErrorField

func (ErrorFields) Len

func (fields ErrorFields) Len() int

func (ErrorFields) Less

func (fields ErrorFields) Less(i, j int) bool

func (ErrorFields) RuntimeDoc

func (ErrorFields) RuntimeDoc(names ...string) ([]string, bool)

func (ErrorFields) String

func (fields ErrorFields) String() string

func (ErrorFields) Swap

func (fields ErrorFields) Swap(i, j int)

type ErrorWithStatusCode

type ErrorWithStatusCode interface {
	Error() string
	StatusCode() int
}

type ErrorWithSummary

type ErrorWithSummary interface {
	Summary() string
}

type StatusErr

type StatusErr struct {
	// http code
	Code int `json:"code" xml:"code"`
	// key of err
	Key string `json:"key" xml:"key"`
	// msg of err
	Msg string `json:"msg" xml:"msg"`
	// desc of err
	Desc string `json:"desc,omitempty" xml:"desc,omitempty"`
	// can be task error
	// for client to should error msg to end user
	CanBeTalkError bool `json:"canBeTalkError,omitempty" xml:"canBeTalkError,omitempty"`
	// error tracing
	Sources []string `json:"sources,omitempty" xml:"sources,omitempty"`
	// error in where fields
	ErrorFields ErrorFields `json:"errorFields,omitempty" xml:"errorFields,omitempty"`
	// contains filtered or unexported fields
}

func FromErr

func FromErr(err error) *StatusErr

func IsStatusErr

func IsStatusErr(err error) (*StatusErr, bool)

func New

func New(err error) *StatusErr

func ParseStatusErrSummary

func ParseStatusErrSummary(str string) (*StatusErr, error)

func Wrap

func Wrap(err error, code int, key string, msgAndDesc ...string) *StatusErr

func (StatusErr) AppendErrorField

func (statusErr StatusErr) AppendErrorField(in string, field string, msg string) *StatusErr

func (StatusErr) AppendErrorFields

func (statusErr StatusErr) AppendErrorFields(errorFields ...*ErrorField) *StatusErr

func (StatusErr) AppendSource

func (statusErr StatusErr) AppendSource(sourceName string) *StatusErr

func (StatusErr) DisableErrTalk

func (statusErr StatusErr) DisableErrTalk() *StatusErr

func (StatusErr) EnableErrTalk

func (statusErr StatusErr) EnableErrTalk() *StatusErr

func (*StatusErr) Error

func (statusErr *StatusErr) Error() string

func (*StatusErr) Format

func (statusErr *StatusErr) Format(s fmt.State, verb rune)

func (*StatusErr) Is

func (statusErr *StatusErr) Is(err error) bool

func (StatusErr) RuntimeDoc

func (v StatusErr) RuntimeDoc(names ...string) ([]string, bool)

func (*StatusErr) StatusCode

func (statusErr *StatusErr) StatusCode() int

func (*StatusErr) Summary

func (statusErr *StatusErr) Summary() string

func (*StatusErr) Unwrap

func (statusErr *StatusErr) Unwrap() error

func (StatusErr) WithDesc

func (statusErr StatusErr) WithDesc(desc string) *StatusErr

func (StatusErr) WithMsg

func (statusErr StatusErr) WithMsg(msg string) *StatusErr

type StatusError

type StatusError interface {
	StatusErr() *StatusErr
	Error() string
}

type WithStackTrace

type WithStackTrace interface {
	StackTrace() errors.StackTrace
}

Jump to

Keyboard shortcuts

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