errors

package

v0.1.0 Latest Latest Go to latest Published: Apr 30, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/paper-board/sdk

Links

Open Source Insights

Documentation ¶

Overview ¶

Package errors provides shared sentinel errors and gRPC mapping for paper-board services. All public service errors should wrap one of these sentinels so callers can use errors.Is for routing.

Index ¶

Variables
func As(err error, target any) bool
func FromGRPCStatus(err error) error
func Is(err, target error) bool
func ToGRPCStatus(err error) error
func Wrap(sentinel error, msg string, kvs ...any) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNotFound         = errors.New("not found")
	ErrConflict         = errors.New("conflict")
	ErrUnauthorized     = errors.New("unauthorized")
	ErrPermissionDenied = errors.New("permission denied")
	ErrInvalidInput     = errors.New("invalid input")
	ErrRateLimited      = errors.New("rate limited")
	ErrInternal         = errors.New("internal error")
	ErrUnavailable      = errors.New("service unavailable")
)

Sentinel errors.

Functions ¶

func As ¶

func As(err error, target any) bool

As re-exports errors.As.

func FromGRPCStatus ¶

func FromGRPCStatus(err error) error

FromGRPCStatus converts a gRPC status error back to a wrapped sentinel. Useful in client code to use errors.Is across the wire.

func Is ¶

func Is(err, target error) bool

Is is a re-export so callers don't need to import stdlib errors separately.

func ToGRPCStatus ¶

func ToGRPCStatus(err error) error

ToGRPCStatus maps a wrapped sentinel error to a gRPC status. Used by service handlers to convert internal errors into RPC responses.

if err := repo.Get(ctx, id); err != nil {
    return nil, errors.ToGRPCStatus(err)
}

func Wrap ¶

func Wrap(sentinel error, msg string, kvs ...any) error

Wrap annotates a sentinel with context. The sentinel remains accessible via errors.Is.

if u == nil {
    return errors.Wrap(errors.ErrNotFound, "user", "id", id)
}

Output: "user (id=...): not found"

Types ¶

This section is empty.

Source Files ¶

View all Source files

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