sourceerror

SourceError

• SourceError
  • Purpose
  • Installation
  • Usage
  • Libraries
  • Licence

Purpose

This module offers the ErrSource error type that wraps another error instance, along with the file name, line number, and function name where the initial error occurred, along with original error's message text and a call stack.

The public fields should be considered R/O - there really isn't any reason to modify those fields apart from confusing yourself :-)

The fields are as follows:

- `File`: The source file where the error was encountered.
- `Function`: The function wherein the error was encountered
- `Line`: The code line within the `File`.
- `Stack`: The call stack to where the error was created.

The ErrSource type provides the methods Error() , String() and Unwrap() as required by the error interface.

The ErrSource can be very useful especially during development to help finding problems in the source code. In case the error call-stacks are not needed just set the NOSTACK flag to true (which will save some time and memory).

Once the source code is free of avoidable errors, just set the NODEBUG flag to true – without any need to change the source code otherwise.

Installation

You can use Go to install this package for you:

go get -u github.com/mwat56/sourceerror@latest

Usage

It can be used by calling the provided constructor function New():

import (
	se "github.com/mwat56/sourceerror"
)

// ...

// IF the call-stacks are not needed:
se.NOSTACK = true

// uncomment the next line when your code is production ready:
// se.NODEBUG = true

// ...

// here some error occurs:
err := someFunction()
if nil != err {
	err = se.New(err, 2)
	// `err` now wraps the original `err` and points
	// two lines up i.e. to the line where the error
	// was encountered.

	return err
	// ... or perform some proper error handling here
}

// ...

Libraries

No external libraries were used building sourceerror.

Licence

    Copyright © 2024, 2025  M.Watermann, 10247 Berlin, Germany
                    All rights reserved
                EMail : <support@mwat.de>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should have received a copy of the GNU General Public License along with this program. If not, see the GNU General Public License for details.