zerrors

package module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 23, 2024 License: MIT Imports: 4 Imported by: 1

README

Zerrors

A error primitives package with a list of grpc based errors that can be used to describe root causes.

Originally forked and extracted from Zitadel zerrors package: Zitadel Errors

Install

go get github.com/mscno/zerrors

This will install the base zerrors package and as well as the httperrors adapter.

If you want to use the grpc adapter, you will need to install the zerrors-grpc package:

go get github.com/mscno/zerrors/grpczerrors

Usage

Basic Usage
package main

import (
    "fmt"
    "github.com/mscno/zerrors"
)

func main() {
	rooterr := fmt.Errorf("root error")
    err := zerrors.ThrowNotFound(rooterr,"NOT_FOUND","my error")
    fmt.Println(err)
}

Documentation

Index

Constants

View Source 
const AlreadyExistsId = "AlreadyExists"
View Source 
const DeadlineExceededId = "DeadlineExceeded"
View Source 
const FailedPreconditionId = "FailedPrecondition"
View Source 
const InternalId = "Internal"
View Source 
const InvalidArgumentId = "InvalidArgument"
View Source 
const NotFoundId = "NotFound"
View Source 
const PermissionDeniedId = "PermissionDenied"
View Source 
const ResourceExhaustedId = "ResourceExhausted"
View Source 
const UnauthenticatedId = "Unauthenticated"
View Source 
const UnavailableId = "Unavailable"
View Source 
const UnimplementedId = "Unimplemented"
View Source 
const UnknownId = "Unknown"

Variables

This section is empty.

Functions

func Contains 

func Contains(err error, needle string) bool

Contains compares the error message with needle

func IsAlreadyExists added in v0.0.2 

func IsAlreadyExists(err error) bool

func IsDeadlineExceeded 

func IsDeadlineExceeded(err error) bool

func IsFailedPrecondition added in v0.0.2 

func IsFailedPrecondition(err error) bool

func IsInternal 

func IsInternal(err error) bool

func IsInvalidArgument added in v0.0.2 

func IsInvalidArgument(err error) bool

func IsNotFound 

func IsNotFound(err error) bool

func IsPermissionDenied 

func IsPermissionDenied(err error) bool

func IsResourceExhausted 

func IsResourceExhausted(err error) bool

func IsUnauthenticated 

func IsUnauthenticated(err error) bool

func IsUnavailable 

func IsUnavailable(err error) bool

func IsUnimplemented 

func IsUnimplemented(err error) bool

func IsUnknown 

func IsUnknown(err error) bool

func ThrowAlreadyExists 

func ThrowAlreadyExists(action, kind, name string) error

func ThrowAlreadyExistsr added in v0.0.2 

func ThrowAlreadyExistsr(action, kind, name, reason string) error

func ThrowDeadlineExceeded 

func ThrowDeadlineExceeded(action, kind, name string) error

func ThrowDeadlineExceededr added in v0.0.2 

func ThrowDeadlineExceededr(action, kind, name, reason string) error

func ThrowError 

func ThrowError(parent error, id, message string) error

func ThrowFailedPrecondition added in v0.0.2 

func ThrowFailedPrecondition(action, kind, name string) error

func ThrowFailedPreconditionr added in v0.0.2 

func ThrowFailedPreconditionr(action, kind, name, reason string) error

func ThrowInternal 

func ThrowInternal(action, kind, name string) error

func ThrowInternalr added in v0.0.2 

func ThrowInternalr(action, kind, name, reason string) error

func ThrowInvalidArgument 

func ThrowInvalidArgument(action, kind, name string) error

func ThrowInvalidArgumentr added in v0.0.2 

func ThrowInvalidArgumentr(action, kind, name, reason string) error

func ThrowNotFound 

func ThrowNotFound(action, kind, name string) error

func ThrowNotFoundr added in v0.0.2 

func ThrowNotFoundr(action, kind, name, reason string) error

func ThrowPermissionDenied 

func ThrowPermissionDenied(action, kind, name string) error

func ThrowPermissionDeniedr added in v0.0.2 

func ThrowPermissionDeniedr(action, kind, name, reason string) error

func ThrowResourceExhausted 

func ThrowResourceExhausted(action, kind, name string) error

func ThrowResourceExhaustedr added in v0.0.2 

func ThrowResourceExhaustedr(action, kind, name, reason string) error

func ThrowUnauthenticated 

func ThrowUnauthenticated(action, kind, name string) error

func ThrowUnauthenticatedr added in v0.0.2 

func ThrowUnauthenticatedr(action, kind, name, reason string) error

func ThrowUnavailable 

func ThrowUnavailable(action, kind, name string) error

func ThrowUnavailabler added in v0.0.2 

func ThrowUnavailabler(action, kind, name, reason string) error

func ThrowUnimplemented 

func ThrowUnimplemented(action, kind, name string) error

func ThrowUnimplementedr added in v0.0.2 

func ThrowUnimplementedr(action, kind, name, reason string) error

func ThrowUnknown 

func ThrowUnknown(action, kind, name string) error

func ThrowUnknownr added in v0.0.2 

func ThrowUnknownr(action, kind, name, reason string) error

func ToAlreadyExists added in v0.0.2 

func ToAlreadyExists(parent error, id string, message string) error

func ToAlreadyExistsf added in v0.0.2 

func ToAlreadyExistsf(parent error, id string, format string, a ...interface{}) error

func ToDeadlineExceeded added in v0.0.2 

func ToDeadlineExceeded(parent error, id string, message string) error

func ToDeadlineExceededf added in v0.0.2 

func ToDeadlineExceededf(parent error, id string, format string, a ...interface{}) error

func ToFailedPrecondition added in v0.0.2 

func ToFailedPrecondition(parent error, id string, message string) error

func ToFailedPreconditionf added in v0.0.2 

func ToFailedPreconditionf(parent error, id string, format string, a ...interface{}) error

func ToInternal added in v0.0.2 

func ToInternal(parent error, id string, message string) error

func ToInternalf added in v0.0.2 

func ToInternalf(parent error, id string, format string, a ...interface{}) error

func ToInvalidArgument added in v0.0.2 

func ToInvalidArgument(parent error, id string, message string) error

func ToInvalidArgumentf added in v0.0.2 

func ToInvalidArgumentf(parent error, id string, format string, a ...interface{}) error

func ToNotFound added in v0.0.2 

func ToNotFound(parent error, id string, message string) error

func ToNotFoundf added in v0.0.2 

func ToNotFoundf(parent error, id string, format string, a ...interface{}) error

func ToPermissionDenied added in v0.0.2 

func ToPermissionDenied(parent error, id string, message string) error

func ToPermissionDeniedf added in v0.0.2 

func ToPermissionDeniedf(parent error, id string, format string, a ...interface{}) error

func ToResourceExhausted added in v0.0.2 

func ToResourceExhausted(parent error, id string, message string) error

func ToResourceExhaustedf added in v0.0.2 

func ToResourceExhaustedf(parent error, id string, format string, a ...interface{}) error

func ToUnauthenticated added in v0.0.2 

func ToUnauthenticated(parent error, id string, message string) error

func ToUnauthenticatedf added in v0.0.2 

func ToUnauthenticatedf(parent error, id string, format string, a ...interface{}) error

func ToUnavailable added in v0.0.2 

func ToUnavailable(parent error, id string, message string) error

func ToUnavailablef added in v0.0.2 

func ToUnavailablef(parent error, id string, format string, a ...interface{}) error

func ToUnimplemented added in v0.0.2 

func ToUnimplemented(parent error, id string, message string) error

func ToUnimplementedf added in v0.0.2 

func ToUnimplementedf(parent error, id string, format string, a ...interface{}) error

func ToUnknown added in v0.0.2 

func ToUnknown(parent error, id string, message string) error

func ToUnknownf added in v0.0.2 

func ToUnknownf(parent error, id string, format string, a ...interface{}) error

Types

type AlreadyExists 

type AlreadyExists interface {
	error
	IsAlreadyExists()
}

type AlreadyExistsError 

type AlreadyExistsError struct {
	*Zerror
}

func (*AlreadyExistsError) Is 

func (err *AlreadyExistsError) Is(target error) bool

func (*AlreadyExistsError) IsAlreadyExists 

func (err *AlreadyExistsError) IsAlreadyExists()

type DeadlineExceeded 

type DeadlineExceeded interface {
	error
	IsDeadlineExceeded()
}

type DeadlineExceededError 

type DeadlineExceededError struct {
	*Zerror
}

func (*DeadlineExceededError) Is 

func (err *DeadlineExceededError) Is(target error) bool

func (*DeadlineExceededError) IsDeadlineExceeded 

func (err *DeadlineExceededError) IsDeadlineExceeded()

type Error 

type Error interface {
	GetParent() error
	GetMessage() string
	SetMessage(string)
	GetID() string
}

Error is a stdlib error extension. It contains parameters to identify errors through all application layers

type FailedPrecondition added in v0.0.2 

type FailedPrecondition interface {
	error
	IsFailedPrecondition()
}

type FailedPreconditionError added in v0.0.2 

type FailedPreconditionError struct {
	*Zerror
}

func (*FailedPreconditionError) Is added in v0.0.2 

func (err *FailedPreconditionError) Is(target error) bool

func (*FailedPreconditionError) IsFailedPrecondition added in v0.0.2 

func (err *FailedPreconditionError) IsFailedPrecondition()

type Internal 

type Internal interface {
	error
	IsInternal()
}

type InternalError 

type InternalError struct {
	*Zerror
}

func (*InternalError) Is 

func (err *InternalError) Is(target error) bool

func (*InternalError) IsInternal 

func (err *InternalError) IsInternal()

type InvalidArgument 

type InvalidArgument interface {
	error
	IsInvalidArgument()
}

type InvalidArgumentError 

type InvalidArgumentError struct {
	*Zerror
}

func (*InvalidArgumentError) Is 

func (err *InvalidArgumentError) Is(target error) bool

func (*InvalidArgumentError) IsInvalidArgument 

func (err *InvalidArgumentError) IsInvalidArgument()

type NotFound 

type NotFound interface {
	error
	IsNotFound()
}

type NotFoundError 

type NotFoundError struct {
	*Zerror
}

func (*NotFoundError) Is 

func (err *NotFoundError) Is(target error) bool

func (*NotFoundError) IsNotFound 

func (err *NotFoundError) IsNotFound()

type PermissionDenied 

type PermissionDenied interface {
	error
	IsPermissionDenied()
}

type PermissionDeniedError 

type PermissionDeniedError struct {
	*Zerror
}

func (*PermissionDeniedError) Is 

func (err *PermissionDeniedError) Is(target error) bool

func (*PermissionDeniedError) IsPermissionDenied 

func (err *PermissionDeniedError) IsPermissionDenied()

type ResourceExhausted 

type ResourceExhausted interface {
	error
	IsResourceExhausted()
}

type ResourceExhaustedError 

type ResourceExhaustedError struct {
	*Zerror
}

func (*ResourceExhaustedError) Is 

func (err *ResourceExhaustedError) Is(target error) bool

func (*ResourceExhaustedError) IsResourceExhausted 

func (err *ResourceExhaustedError) IsResourceExhausted()

type Unauthenticated 

type Unauthenticated interface {
	error
	IsUnauthenticated()
}

type UnauthenticatedError 

type UnauthenticatedError struct {
	*Zerror
}

func (*UnauthenticatedError) Is 

func (err *UnauthenticatedError) Is(target error) bool

func (*UnauthenticatedError) IsUnauthenticated 

func (err *UnauthenticatedError) IsUnauthenticated()

type Unavailable 

type Unavailable interface {
	error
	IsUnavailable()
}

type UnavailableError 

type UnavailableError struct {
	*Zerror
}

func (*UnavailableError) Is 

func (err *UnavailableError) Is(target error) bool

func (*UnavailableError) IsUnavailable 

func (err *UnavailableError) IsUnavailable()

type Unimplemented 

type Unimplemented interface {
	error
	IsUnimplemented()
}

type UnimplementedError 

type UnimplementedError struct {
	*Zerror
}

func (*UnimplementedError) Is 

func (err *UnimplementedError) Is(target error) bool

func (*UnimplementedError) IsUnimplemented 

func (err *UnimplementedError) IsUnimplemented()

type Unknown 

type Unknown interface {
	error
	IsUnknown()
}

type UnknownError 

type UnknownError struct {
	*Zerror
}

func (*UnknownError) Is 

func (err *UnknownError) Is(target error) bool

func (*UnknownError) IsUnknown 

func (err *UnknownError) IsUnknown()

type Zerror 

type Zerror struct {
	Parent  error
	Message string
	ID      string
}

func CreateZerror added in v0.0.2 

func CreateZerror(parent error, id, message string) *Zerror

func (*Zerror) As 

func (err *Zerror) As(target interface{}) bool

func (*Zerror) Error 

func (err *Zerror) Error() string

func (*Zerror) GetID 

func (err *Zerror) GetID() string

func (*Zerror) GetMessage 

func (err *Zerror) GetMessage() string

func (*Zerror) GetParent 

func (err *Zerror) GetParent() error

func (*Zerror) Is 

func (err *Zerror) Is(target error) bool

func (*Zerror) SetMessage 

func (err *Zerror) SetMessage(msg string)

func (*Zerror) Unwrap 

func (err *Zerror) Unwrap() error

Source Files

View all Source files

Directories

Path Synopsis
generate module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.