srverr

package

v1.15.0 Latest Latest Go to latest Published: Mar 29, 2024 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/brimdata/zed

Links

Open Source Insights

Documentation ¶

Overview ¶

Package zqe provides a mechanism to create or wrap errors with information that will aid in reporting them to users and returning them to api callers.

Index ¶

func E(args ...interface{}) error
func ErrConflict(args ...interface{}) error
func ErrExists(args ...interface{}) error
func ErrForbidden(args ...interface{}) error
func ErrInvalid(args ...interface{}) error
func ErrNoCredentials(args ...interface{}) error
func ErrNotFound(args ...interface{}) error
func ErrOther(args ...interface{}) error
func IsConflict(err error) bool
func IsExists(err error) bool
func IsForbidden(err error) bool
func IsInvalid(err error) bool
func IsKind(err error, k Kind) bool
func IsNoCredentials(err error) bool
func IsNotFound(err error) bool
func IsOther(err error) bool
func RecoverError(r interface{}) error
type Error
- func (e *Error) Error() string
- func (e *Error) Is(target error) bool
- func (e *Error) Message() string
- func (e *Error) Unwrap() error
type Kind
- func (k Kind) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func E ¶

func E(args ...interface{}) error

Function E generates an error from any mix of:

a Kind
an existing error
a string and optional formatting verbs, like fmt.Errorf (including support for the `%w` verb).

The string & format verbs must be last in the arguments, if present.

func ErrConflict ¶

func ErrConflict(args ...interface{}) error

func ErrExists ¶

func ErrExists(args ...interface{}) error

func ErrForbidden ¶

func ErrForbidden(args ...interface{}) error

func ErrInvalid ¶

func ErrInvalid(args ...interface{}) error

func ErrNoCredentials ¶

func ErrNoCredentials(args ...interface{}) error

func ErrNotFound ¶

func ErrNotFound(args ...interface{}) error

func ErrOther ¶

func ErrOther(args ...interface{}) error

func IsConflict ¶

func IsConflict(err error) bool

func IsExists ¶

func IsExists(err error) bool

func IsForbidden ¶

func IsForbidden(err error) bool

func IsInvalid ¶

func IsInvalid(err error) bool

func IsKind ¶

func IsKind(err error, k Kind) bool

IsKind returns true if the provided error can be unwrapped as a *Error and if *Error.Kind matches the provided Kind

func IsNoCredentials ¶

func IsNoCredentials(err error) bool

func IsNotFound ¶

func IsNotFound(err error) bool

func IsOther ¶

func IsOther(err error) bool

func RecoverError ¶

func RecoverError(r interface{}) error

Types ¶

type Error ¶

type Error struct {
	Kind Kind
	Err  error
}

func (*Error) Error ¶

func (e *Error) Error() string

func (*Error) Is ¶

func (e *Error) Is(target error) bool

func (*Error) Message ¶

func (e *Error) Message() string

Message returns just the Err.Error() string, if present, or the Kind string description. The intent is to allow zqe users a way to avoid embedding the Kind description as happens with Error().

func (*Error) Unwrap ¶

func (e *Error) Unwrap() error

type Kind ¶

type Kind int

A Kind represents a class of error. API layers will typically convert these into a domain specific error representation; for example, an HTTP handler can convert these to HTTP status codes.

const (
	Other Kind = iota
	Conflict
	Exists
	Forbidden
	Invalid
	NoCredentials
	NotFound
)

func (Kind) String ¶

func (k Kind) String() string

Source Files ¶

View all Source files

error.go

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