uniform-error: Handling errors in the uniform framework

[ error-exception-uniform, gpl, library ] [ Propose Tags ] [ Report a vulnerability ]

A minimal package to handle errors and exception in a simple but flexible way. Includes functions to adapt the prefered method of calling IO with error handling (ErrIO) to the approaches encountered in other packages when writing applications.

Please see the README on GitHub at https://github.com/andrewufrank/uniform-error/readme


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0, 0.1.3, 0.1.3.1, 0.1.5.1
Change log ChangeLog.md
Dependencies base (>=4.7 && <5), data-default, safe, transformers, uniform-strings (>=0.1.5) [details]
License GPL-2.0-only
Copyright 2021 Andrew U. Frank
Author Andrew Frank
Maintainer Andrew U. Frank <uniform@gerastree.at>
Category Error Exception Uniform
Home page https://github.com/github.com:andrewufrank/uniform-error.git#readme
Bug tracker https://github.com/andrewufrank/uniform-error/issues
Source repo head: git clone https://github.com/github.com:andrewufrank/uniform-error.git
Uploaded by andrewufrank at 2023-03-06T14:07:11Z
Distributions NixOS:0.1.5.1
Reverse Dependencies 3 direct, 10 indirect [details]
Downloads 398 total (12 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2023-03-06 [all 1 reports]

Readme for uniform-error-0.1.5.1

[back to package description]

Error.hs defines an uniform approach to error: any function which can fail returns a value of - ErrIO, which is a wrapper around IO, returning a Text messages if the computation fails - ErrOrVal (which is Either Text) for functions not in the IO monad

All cases where functions use other error signaling methods must be converted as part of their integration into the uniform framework.

Especially important are the functions to convert to regular IO:

  • callIO which calls an IO function and catches a possible error return.

  • converts back functions running in ErrIO a into (normal) IO (ErrOrVal a) which is used when functions from the uniform style are used where functions in the normal IO monad are expected.

Some other functions are helpful to identify hard to track problems in Haskell:

undef to find where an undefined value is used, producing an error message.

The StartApp is a bridge between the ErrIO used here and the standard IO monad in main:: IO ()

The package depends on uniform-string.