xerror

package

v0.0.0-...-5a98790 Latest Latest Go to latest Published: Jul 25, 2021 License: MIT Imports: 3 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/thecodingmachine/gotenberg

Documentation ¶

Overview ¶

Package xerror helps standardizing the errors through the application.

Credits: https://middlemost.com/failure-is-your-domain/

Index ¶

func Invalid(op, message string, previous error) error
func Message(err error) string
func New(op string, previous error) error
func Op(err error) string
func Timeout(op, message string, previous error) error
type Error
- func (e Error) Error() string
type ErrorCode
- func Code(err error) ErrorCode

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Invalid ¶

func Invalid(op, message string, previous error) error

Invalid returns a xerror.Error.

Should be used when an input is wrong.

func Message ¶

func Message(err error) string

Message returns the human-readable message of the error, if available. Otherwise returns a generic error message.

func New ¶

func New(op string, previous error) error

New returns a xerror.Error.

Should be used for wrapping an error at the end of a function.

func Op ¶

func Op(err error) string

Op returns the logical operation of the error, if available. Otherwise returns an empty string.

func Timeout ¶

func Timeout(op, message string, previous error) error

Timeout returns a xerror.Error.

Should be used when a timeout occurs.

Types ¶

type Error ¶

type Error struct {
	// contains filtered or unexported fields
}

Error defines our standard application error.

func (Error) Error ¶

func (e Error) Error() string

Error returns the string representation of the error message.

type ErrorCode ¶

type ErrorCode string

ErrorCode is machine-readable error code.

const (
	// InternalCode is an internal error.
	InternalCode ErrorCode = "internal"
	// InvalidCode occurs when a validation
	// failed.
	InvalidCode ErrorCode = "invalid"
	// TimeoutCode occurs when something
	// timed out.
	TimeoutCode ErrorCode = "timeout"
)

func Code ¶

func Code(err error) ErrorCode

Code returns the code of the root error, if available. Otherwise returns InternalCode.

Source Files ¶

View all Source files

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