errs

errs is a package for handling errors with reasons for Golang programs.

This package provides the structure type Err which takes a parameter of any type as a reason for an error. This parameter is typically a structure type, and its name represents the reason, and its fields represent the situation where the error occurred.

Features

• Structured error representation using any Go type as the error reason.
• Type-safe error handling through type switches or type assertions.
• Optional error cause to support error chaining.
• Captured file and line number where the error was created.
• Optional error notification system enabled via build tag: github.sttk.errs.notify.

Installation

go get github.com/sttk/errs

Usage

Creates Err(s)

First, imports errs package as follows:

import "github.com/sttk/errs"

Next, defines structure types which represent reasons of errors.

type /* error reasons */ (
  FailToDoSomething struct {}

  FailToDoWithParams struct {
    Param1 string,
    Param2 int,
  }
)

Then, creates Err(s).

func f0() errs.Err {
    ...
    return errs.Ok()
}

func f1() errs.Err {
    ...
    return errs.New(FailToDoSomething{})
}

func f2() errs.Err {
    ...
    return errs.New(FailToDoWithParams{Param1: "abc", Param2: 123})
}

It is enabled to use an Err as an error.

func f3() error {
    ...
    return errs.New(FailToDoSomething{})
}

It is enabled to take a cause error.

var cause = errors.New("I/O timeout")

func f4() errs.Err {
    ...
    return errs.New(FailToDoWithParams{Param1: "abc", Param2: 123}, cause)
}

Operating a Err

err := f4()

fmt.Println(err.Reason())  // => path/to/pkg.FailToDoWithParams { Param1: abc, Param2: 123 }
fmt.Println(err.File())    // e.g. source_file.go
fmt.Println(err.Line())    // e.g. 123
fmt.Println(err.Cause())   // => I/O timeout
fmt.Println(err.Error())   // => github.com/sttk/errs.Err { reason = path/to/pkg.FailToDoWithParams { Param1: abc, Param2: 123 }, file = source_file.go, line = 123, cause = I/O timeout }

fmt.Println(err.IsOk())    // => true
fmt.Println(err.IsNotOk()) // => false

fmt.Println(err.Unwrap())  // => I/O timeout
fmt.Println(errors.Is(err, cause)) // => true

err := f0().IfOkThen(func() errs.Err {
    // This function is executed.
})

err := f1().IsOkThen(func() errs.Err {
    // This function is not executed.
})

Type-safe error handling

A reason of an Err can be identified with a type-switch statement.

switch reason := err.Reason().(type) {
case FailToDoSomething:
  fmt.Println("FailToDoSomething")
case FailToDoWithParams:
  fmt.Printf("FailToDoWithParam: Param1 = %s, Param = %d\n", reason.Param1, reason.Param2)
default:
  fmt.Println("Unknown reason")
}

Error notification (Optional)

To use the error notification feature, build with the tag: github.sttk.errs.notify.

Adds synchronous/asynchronous handlers.

errs.AddSyncErrHandler(func(e errs.Err, tm time.Time) {
    fmt.Println("SYNC:", tm, e)
})

errs.AddAsyncErrHandler(func(e errs.Err, tm time.Time) {
    logToRemoteServer(e, tm)
})

Prevents the addition of extra error handlers and enables error notifications.

errs.FixErrHandlers()

After this point, each time an Err is created, it will be notified to the registered error handlers.

Supporting Go versions

This framework supports Go 1.18 or later.

Actual test results for each Go version:

% gvm-fav -tags=github.sttk.errs.notify
Now using version go1.18.10
go version go1.18.10 darwin/amd64
ok  	github.com/sttk/errs	0.804s	coverage: 100.0% of statements

Now using version go1.19.13
go version go1.19.13 darwin/amd64
ok  	github.com/sttk/errs	0.858s	coverage: 100.0% of statements

Now using version go1.20.14
go version go1.20.14 darwin/amd64
ok  	github.com/sttk/errs	0.787s	coverage: 100.0% of statements

Now using version go1.21.13
go version go1.21.13 darwin/amd64
ok  	github.com/sttk/errs	0.789s	coverage: 100.0% of statements

Now using version go1.22.10
go version go1.22.10 darwin/amd64
ok  	github.com/sttk/errs	0.793s	coverage: 100.0% of statements

Now using version go1.23.8
go version go1.23.8 darwin/amd64
ok  	github.com/sttk/errs	0.795s	coverage: 100.0% of statements

Now using version go1.24.2
go version go1.24.2 darwin/amd64
ok  	github.com/sttk/errs	0.802s	coverage: 100.0% of statements

Back to go1.24.2
Now using version go1.24.2

License

Copyright (C) 2025 Takayuki Sato

This program is free software under MIT License.
See the file LICENSE in this distribution for more details.