zerrors

package module
v0.0.5 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 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 ErrAlreadyExists = "already exists"
View Source 
const ErrDeadlineExceeded = "deadline exceeded"
View Source 
const ErrFailedPrecondition = "failed precondition"
View Source 
const ErrInternal = "internal"
View Source 
const ErrInvalidArgument = "invalid argument"
View Source 
const ErrNotFound = "not found"
View Source 
const ErrPermissionDenied = "permission denied"
View Source 
const ErrResourceExhausted = "resource exhausted"
View Source 
const ErrUnauthenticated = "unauthenticated"
View Source 
const ErrUnavailable = "unavailable"
View Source 
const ErrUnimplemented = "unimplemented"
View Source 
const ErrUnknown = "unknown"

Variables

This section is empty.

Functions

func AlreadyExists 

func AlreadyExists(message string, KVs ...interface{}) error

func AlreadyExistsBuilder added in v0.0.3 

func AlreadyExistsBuilder() oops.OopsErrorBuilder

func AlreadyExistsf added in v0.0.5 

func AlreadyExistsf(format string, a ...interface{}) error

func Contains 

func Contains(err error, needle string) bool

Contains compares the error message with needle

func DeadlineExceeded 

func DeadlineExceeded(message string, KVs ...interface{}) error

func DeadlineExceededBuilder added in v0.0.3 

func DeadlineExceededBuilder() oops.OopsErrorBuilder

func DeadlineExceededf added in v0.0.5 

func DeadlineExceededf(format string, a ...interface{}) error

func FailedPrecondition added in v0.0.2 

func FailedPrecondition(message string, KVs ...interface{}) error

func FailedPreconditionBuilder added in v0.0.3 

func FailedPreconditionBuilder() oops.OopsErrorBuilder

func FailedPreconditionf added in v0.0.5 

func FailedPreconditionf(format string, a ...interface{}) error

func Internal 

func Internal(message string, KVs ...interface{}) error

func InternalBuilder added in v0.0.3 

func InternalBuilder() oops.OopsErrorBuilder

func Internalf added in v0.0.5 

func Internalf(format string, a ...interface{}) error

func InvalidArgument 

func InvalidArgument(message string, KVs ...interface{}) error

func InvalidArgumentBuilder added in v0.0.3 

func InvalidArgumentBuilder() oops.OopsErrorBuilder

func InvalidArgumentf added in v0.0.5 

func InvalidArgumentf(format string, a ...interface{}) error

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 NotFound 

func NotFound(message string, KVs ...interface{}) error

func NotFoundBuilder added in v0.0.3 

func NotFoundBuilder() oops.OopsErrorBuilder

func NotFoundf added in v0.0.5 

func NotFoundf(format string, a ...interface{}) error

func PermissionDenied 

func PermissionDenied(message string, KVs ...interface{}) error

func PermissionDeniedBuilder added in v0.0.3 

func PermissionDeniedBuilder() oops.OopsErrorBuilder

func PermissionDeniedf added in v0.0.5 

func PermissionDeniedf(format string, a ...interface{}) error

func ResourceExhausted 

func ResourceExhausted(message string, KVs ...interface{}) error

func ResourceExhaustedBuilder added in v0.0.3 

func ResourceExhaustedBuilder() oops.OopsErrorBuilder

func ResourceExhaustedf added in v0.0.5 

func ResourceExhaustedf(format string, a ...interface{}) error

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 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, format string, a ...interface{}) error

func ToDeadlineExceeded added in v0.0.2 

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

func ToFailedPrecondition added in v0.0.2 

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

func ToInternal added in v0.0.2 

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

func ToInvalidArgument added in v0.0.2 

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

func ToNotFound added in v0.0.2 

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

func ToPermissionDenied added in v0.0.2 

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

func ToResourceExhausted added in v0.0.2 

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

func ToUnauthenticated added in v0.0.2 

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

func ToUnavailable added in v0.0.2 

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

func ToUnimplemented added in v0.0.2 

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

func ToUnknown added in v0.0.2 

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

func Unauthenticated 

func Unauthenticated(message string, KVs ...interface{}) error

func UnauthenticatedBuilder added in v0.0.3 

func UnauthenticatedBuilder() oops.OopsErrorBuilder

func Unauthenticatedf added in v0.0.5 

func Unauthenticatedf(format string, a ...interface{}) error

func Unavailable 

func Unavailable(message string, KVs ...interface{}) error

func UnavailableBuilder added in v0.0.3 

func UnavailableBuilder() oops.OopsErrorBuilder

func Unavailablef added in v0.0.5 

func Unavailablef(format string, a ...interface{}) error

func Unimplemented 

func Unimplemented(message string, KVs ...interface{}) error

func UnimplementedBuilder added in v0.0.3 

func UnimplementedBuilder() oops.OopsErrorBuilder

func Unimplementedf added in v0.0.5 

func Unimplementedf(format string, a ...interface{}) error

func Unknown 

func Unknown(message string, KVs ...interface{}) error

func UnknownBuilder added in v0.0.3 

func UnknownBuilder() oops.OopsErrorBuilder

func Unknownf added in v0.0.5 

func Unknownf(format string, a ...interface{}) error

Types

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

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.