errors

Documentation

Index

• type Error
  • func New(code ErrorCode) *Error
  • func (e *Error) Code() ErrorCode
  • func (e *Error) Error() string
• type ErrorCode
  • func (c ErrorCode) ToString() string

Types

type Error

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

Error is a custom error type that implements the error interface.

func New

func New(code ErrorCode) *Error

New returns a new error.

func (*Error) Code

func (e *Error) Code() ErrorCode

Code returns the error code.

func (*Error) Error

func (e *Error) Error() string

Error returns the error message.

type ErrorCode

type ErrorCode int

ErrorCode is a custom error code type.

const (
	// ErrCollectionNameIsEmpty is returned when the collection name is empty.
	ErrCollectionNameIsEmpty ErrorCode = 1000 + iota
	// ErrCollectionNameIsInvalid is returned when the collection name is invalid.
	ErrCollectionNameIsInvalid
)

Error codes.

const (
	// ErrDocumentNotFound is returned when a document is not found.
	ErrDocumentNotFound ErrorCode = 3000 + iota
)

const (
	// ErrUnauthorized is returned when a user is not authorized to perform an action.
	ErrUnauthorized ErrorCode = 2000 + iota
)

func (ErrorCode) ToString

func (c ErrorCode) ToString() string