Documentation ¶
Index ¶
- type Aggregate
- type Error
- func Duplicate(field *Path, value interface{}) *Error
- func Forbidden(field *Path, detail string) *Error
- func InternalError(field *Path, err error) *Error
- func Invalid(field *Path, value interface{}, detail string) *Error
- func NotFound(field *Path, value interface{}) *Error
- func NotSupported(field *Path, value interface{}, validValues []string) *Error
- func Required(field *Path, detail string) *Error
- func TooFew(field *Path, actualQuantity, maxQuantity int) *Error
- func TooLong(field *Path, value interface{}, maxLength int) *Error
- func TooMany(field *Path, actualQuantity, maxQuantity int) *Error
- func TooShort(field *Path, value interface{}, minLength int) *Error
- type ErrorList
- func (v ErrorList) Find(field string) *ErrorList
- func (v ErrorList) FindFamily(field string) *ErrorList
- func (v ErrorList) HasError(field string, errType ErrorType) bool
- func (v ErrorList) HasMany() bool
- func (v ErrorList) IsEmpty() bool
- func (v *ErrorList) Length() int
- func (v ErrorList) Status(code int, msg string) Status
- func (v ErrorList) ToAggregate() Aggregate
- type ErrorType
- type Path
- type Status
- type StatusType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Aggregate ¶
func NewAggregate ¶
NewAggregate converts a slice of errors into an Aggregate interface, which is itself an implementation of the error interface. If the slice is empty, this returns nil. It will check if any of the element of input error list is nil, to avoid nil pointer panic when call Error().
type Error ¶
type Error struct { Type ErrorType `json:"type"` Field string `json:"field"` BadValue interface{} `json:"badValue"` Detail string `json:"detail"` }
Error is an implementation of the 'error' interface, which represents a field-level validation error.
func Duplicate ¶
Duplicate returns a *Error indicating "duplicate value". This is used to report collisions of values that must be unique (e.g. names or IDs).
func Forbidden ¶
Forbidden returns a *Error indicating "forbidden". This is used to report valid (as per formatting rules) values which would be accepted under some conditions, but which are not permitted by current conditions (e.g. security policy).
func InternalError ¶
InternalError returns a *Error indicating "internal error". This is used to signal that an error was found that was not directly related to user input. The err argument must be non-nil.
func Invalid ¶
Invalid returns a *Error indicating "invalid value". This is used to report malformed values (e.g. failed regex match, too long, out of bounds).
func NotFound ¶
NotFound returns a *Error indicating "value not found". This is used to report failure to find a requested value (e.g. looking up an ID).
func NotSupported ¶
NotSupported returns a *Error indicating "unsupported value". This is used to report unknown values for enumerated fields (e.g. a list of valid values).
func Required ¶
Required returns a *Error indicating "value required". This is used to report required values that are not provided (e.g. empty strings, null values, or empty arrays).
func TooFew ¶
TooFew returns a *Error indicating "too few". This is used to report that a given list has too few items. This is similar to TooShort, but the returned error indicates quantity instead of length.
func TooLong ¶
TooLong returns a *Error indicating "too long". This is used to report that the given value is too long. This is similar to Invalid, but the returned error will not include the too-long value.
func TooMany ¶
TooMany returns a *Error indicating "too many". This is used to report that a given list has too many items. This is similar to TooLong, but the returned error indicates quantity instead of length.
type ErrorList ¶
type ErrorList []*Error
ErrorList holds a set of Errors. It is plausible that we might one day have non-field errors in this same umbrella package, but for now we don't, so we can keep it simple and leave ErrorList here.
func (ErrorList) FindFamily ¶
func (ErrorList) ToAggregate ¶
ToAggregate converts the ErrorList into an errors.Aggregate.
type ErrorType ¶
type ErrorType string
ErrorType is a machine readable value providing more detail about why a field is invalid. These values are expected to match 1-1 with CauseType in api/form.go.
const ( // ErrorTypeNotFound is used to report failure to find a requested value // (e.g. looking up an ID). See NotFound(). ErrorTypeNotFound ErrorType = "FieldValueNotFound" // ErrorTypeRequired is used to report required values that are not // provided (e.g. empty strings, null values, or empty arrays). See // Required(). ErrorTypeRequired ErrorType = "FieldValueRequired" // ErrorTypeDuplicate is used to report collisions of values that must be // unique (e.g. unique IDs). See Duplicate(). ErrorTypeDuplicate ErrorType = "FieldValueDuplicate" // ErrorTypeInvalid is used to report malformed values (e.g. failed regex // match, too long, out of bounds). See Invalid(). ErrorTypeInvalid ErrorType = "FieldValueInvalid" // ErrorTypeNotSupported is used to report unknown values for enumerated // fields (e.g. a list of valid values). See NotSupported(). ErrorTypeNotSupported ErrorType = "FieldValueNotSupported" // ErrorTypeForbidden is used to report valid (as per formatting rules) // values which would be accepted under some conditions, but which are not // permitted by the current conditions (such as security policy). See // Forbidden(). ErrorTypeForbidden ErrorType = "FieldValueForbidden" // ErrorTypeTooLong is used to report that the given value is too long. // This is similar to ErrorTypeInvalid, but the error will not include the // too-long value. See TooLong(). ErrorTypeTooLong ErrorType = "FieldValueTooLong" // ErrorTypeTooShort is used to report that the given value is too short. // This is similar to ErrorTypeInvalid, but the error will not include the // too-short value. See TooShort(). ErrorTypeTooShort ErrorType = "FieldValueTooShort" // ErrorTypeTooMany is used to report "too many". This is used to // report that a given list has too many items. This is similar to FieldValueTooLong, // but the error indicates quantity instead of length. ErrorTypeTooMany ErrorType = "FieldValueTooMany" // ErrorTypeTooFew is used to report "too few". This is used to // report that a given list has too few items. This is similar to FieldValueTooShort, // but the error indicates quantity instead of length. ErrorTypeTooFew ErrorType = "FieldValueTooFew" // ErrorTypeInternal is used to report other errors that are not related // to user input. See InternalError(). ErrorTypeInternal ErrorType = "InternalError" )
TODO: These values are duplicated in api/form.go, but there's a circular dep. Fix it.
type Path ¶
type Path struct {
// contains filtered or unexported fields
}
Path represents the path from some root to a particular field.
func (*Path) Index ¶
Index indicates that the previous Path is to be subscripted by an int. This sets the same underlying value as Key.
type Status ¶
type Status struct { Status StatusType `json:"status"` Code int `json:"code"` Message string `json:"message"` Errors ErrorList `json:"errors"` }
type StatusType ¶
type StatusType string
const ( Success StatusType = "Success" Failure StatusType = "Failure" )