errs

Documentation

Index

• func Errorf(code ErrorCode, args ...interface{}) error
• func GetCode(err error) codes.Code
• func GetValue(err error, key string) any
• func GetValues(err error) map[string]any
• func WithValue(err error, key string, value any) error
• type ErrorCode

Examples

• GetValue
• GetValues
• WithValue
• WithValue (Nil)

Functions

func Errorf

func Errorf(code ErrorCode, args ...interface{}) error

Errorf create standard error from code

func GetCode

func GetCode(err error) codes.Code

GetCode returns the error's code

func GetValue

func GetValue(err error, key string) any

GetValue returns the first key-matched value found in the error details, or nil.

Example

package main

import (
	"fmt"
	"io"

	"gitlab.com/picnic-app/backend/libs/golang/core/errs"
)

func main() {
	err := io.EOF
	err = errs.WithValue(err, "key", "value")

	fmt.Println(errs.GetValue(err, "key"))

}

Output:

value

func GetValues

func GetValues(err error) map[string]any

GetValues returns all details stored in the error.

Example

package main

import (
	"fmt"
	"io"

	"gitlab.com/picnic-app/backend/libs/golang/core/errs"
)

func main() {
	err := io.EOF
	err = errs.WithValue(err, "key1", "value")
	err = errs.WithValue(err, "key2", 1)
	err = errs.WithValue(err, "key2", 2)
	err = errs.WithValue(err, "key2", 3)

	fmt.Println(errs.GetValues(err))

}

Output:

map[key1:value key2:[1 2 3]]

func WithValue

func WithValue(err error, key string, value any) error

WithValue returns error storing the value for the specified key.

Example

package main

import (
	"io"

	"gitlab.com/picnic-app/backend/libs/golang/core/errs"
)

func main() {
	err := io.EOF
	_ = errs.WithValue(err, "some_key", "some_value")
}

Example (Nil)

package main

import (
	"gitlab.com/picnic-app/backend/libs/golang/core/errs"
)

func main() {
	_ = errs.WithValue(nil, "some_key", "some_value")
}

Types

type ErrorCode

type ErrorCode uint32

ErrorCode ..

const (
	CodeUnknown ErrorCode = iota
	CodeUnauthenticated
	CodeDBNotFound
	CodeInternalError
)

..