gin/errors.go

160 lines
3.2 KiB
Go
Raw Normal View History

2015-03-26 13:10:46 +00:00
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
package gin
import (
"bytes"
"fmt"
2015-05-22 02:43:43 +00:00
"reflect"
"github.com/json-iterator/go"
2015-03-26 13:10:46 +00:00
)
var json = jsoniter.ConfigCompatibleWithStandardLibrary
2015-05-22 23:59:36 +00:00
type ErrorType uint64
2015-03-26 13:10:46 +00:00
const (
2015-05-22 23:59:36 +00:00
ErrorTypeBind ErrorType = 1 << 63 // used when c.Bind() fails
ErrorTypeRender ErrorType = 1 << 62 // used when c.Render() fails
ErrorTypePrivate ErrorType = 1 << 0
ErrorTypePublic ErrorType = 1 << 1
2015-05-22 01:25:21 +00:00
2015-05-22 23:59:36 +00:00
ErrorTypeAny ErrorType = 1<<64 - 1
ErrorTypeNu = 2
2015-03-26 13:10:46 +00:00
)
2017-07-05 07:47:36 +00:00
type Error struct {
Err error
Type ErrorType
Meta interface{}
}
2015-05-22 17:21:35 +00:00
2017-07-05 07:47:36 +00:00
type errorMsgs []*Error
2015-05-22 01:25:21 +00:00
2015-05-22 14:39:15 +00:00
var _ error = &Error{}
2015-05-22 23:59:36 +00:00
func (msg *Error) SetType(flags ErrorType) *Error {
2015-05-22 14:39:15 +00:00
msg.Type = flags
2015-05-22 01:25:21 +00:00
return msg
}
2015-05-22 14:39:15 +00:00
func (msg *Error) SetMeta(data interface{}) *Error {
msg.Meta = data
2015-05-22 01:25:21 +00:00
return msg
2015-03-26 13:10:46 +00:00
}
2015-05-22 14:39:15 +00:00
func (msg *Error) JSON() interface{} {
2015-05-22 02:43:43 +00:00
json := H{}
2015-05-22 14:39:15 +00:00
if msg.Meta != nil {
value := reflect.ValueOf(msg.Meta)
2015-05-22 02:43:43 +00:00
switch value.Kind() {
case reflect.Struct:
2015-05-22 14:39:15 +00:00
return msg.Meta
2015-05-22 02:43:43 +00:00
case reflect.Map:
for _, key := range value.MapKeys() {
json[key.String()] = value.MapIndex(key).Interface()
}
2015-05-22 14:39:15 +00:00
default:
json["meta"] = msg.Meta
2015-05-22 02:43:43 +00:00
}
}
if _, ok := json["error"]; !ok {
json["error"] = msg.Error()
}
return json
}
2016-04-14 23:16:46 +00:00
// MarshalJSON implements the json.Marshaller interface
func (msg *Error) MarshalJSON() ([]byte, error) {
return json.Marshal(msg.JSON())
}
2017-07-06 01:28:16 +00:00
// Error implements the error interface
func (msg Error) Error() string {
2015-05-22 01:43:39 +00:00
return msg.Err.Error()
}
2015-06-12 19:33:16 +00:00
func (msg *Error) IsType(flags ErrorType) bool {
return (msg.Type & flags) > 0
}
2017-07-06 01:28:16 +00:00
// ByType returns a readonly copy filtered the byte.
2015-05-29 19:03:41 +00:00
// ie ByType(gin.ErrorTypePublic) returns a slice of errors with type=ErrorTypePublic
2015-05-22 23:59:36 +00:00
func (a errorMsgs) ByType(typ ErrorType) errorMsgs {
2015-03-26 13:10:46 +00:00
if len(a) == 0 {
2015-06-06 15:24:16 +00:00
return nil
2015-03-26 13:10:46 +00:00
}
if typ == ErrorTypeAny {
return a
}
2016-04-14 23:16:46 +00:00
var result errorMsgs
2015-03-26 13:10:46 +00:00
for _, msg := range a {
if msg.IsType(typ) {
2015-03-26 13:10:46 +00:00
result = append(result, msg)
}
}
return result
}
2017-07-06 01:28:16 +00:00
// Last returns the last error in the slice. It returns nil if the array is empty.
2015-05-29 19:03:41 +00:00
// Shortcut for errors[len(errors)-1]
2015-05-22 14:39:15 +00:00
func (a errorMsgs) Last() *Error {
2017-07-06 01:28:16 +00:00
if length := len(a); length > 0 {
2015-07-02 16:42:33 +00:00
return a[length-1]
2015-05-22 01:43:39 +00:00
}
2015-07-02 16:42:33 +00:00
return nil
2015-05-22 01:43:39 +00:00
}
2017-07-06 01:28:16 +00:00
// Errors returns an array will all the error messages.
2016-01-26 21:40:29 +00:00
// Example:
// c.Error(errors.New("first"))
// c.Error(errors.New("second"))
// c.Error(errors.New("third"))
// c.Errors.Errors() // == []string{"first", "second", "third"}
2015-05-09 01:34:43 +00:00
func (a errorMsgs) Errors() []string {
if len(a) == 0 {
return nil
2015-05-09 01:34:43 +00:00
}
2015-05-12 13:22:13 +00:00
errorStrings := make([]string, len(a))
2015-05-09 01:34:43 +00:00
for i, err := range a {
2015-05-22 01:43:39 +00:00
errorStrings[i] = err.Error()
2015-05-09 01:34:43 +00:00
}
2015-05-12 13:22:13 +00:00
return errorStrings
2015-05-09 01:34:43 +00:00
}
2015-05-22 02:43:43 +00:00
func (a errorMsgs) JSON() interface{} {
switch len(a) {
case 0:
return nil
case 1:
return a.Last().JSON()
default:
json := make([]interface{}, len(a))
for i, err := range a {
json[i] = err.JSON()
}
return json
}
}
func (a errorMsgs) MarshalJSON() ([]byte, error) {
return json.Marshal(a.JSON())
}
2015-03-26 13:10:46 +00:00
func (a errorMsgs) String() string {
if len(a) == 0 {
return ""
}
var buffer bytes.Buffer
for i, msg := range a {
2015-05-22 14:39:15 +00:00
fmt.Fprintf(&buffer, "Error #%02d: %s\n", (i + 1), msg.Err)
if msg.Meta != nil {
fmt.Fprintf(&buffer, " Meta: %v\n", msg.Meta)
}
2015-03-26 13:10:46 +00:00
}
return buffer.String()
}