recover-rtti: Recover run-time type information from the GHC heap

[ bsd3, debugging, library ] [ Propose Tags ]

The main function in this package is classify, which looks at the GHC heap to recover type information about arbitrary values. This makes it possible for example to show any value (function anythingToString) without having any Show instance in scope, though there are other use cases as well. For example, you could use it to define an anythingToJSON function.


[Skip to Readme]
Versions [RSS] [faq] 0.1.0.0, 0.2.0.0, 0.2.1.0, 0.3.0.0, 0.4.0.0 (info)
Change log CHANGELOG.md
Dependencies aeson (==1.5.*), base (>=4.13 && <4.16), bytestring (==0.10.*), containers (==0.6.*), ghc-heap (>=8.8 && <9.1), mtl (==2.2.*), sop-core (==0.5.*), stm (==2.5.*), text (==1.2.*), unordered-containers, vector [details]
License BSD-3-Clause
Copyright Juspay Technologies Pvt Ltd, Well-Typed LLP
Author Edsko de Vries
Maintainer edsko@well-typed.com
Category Debugging
Bug tracker https://github.com/well-typed/recover-rtti/issues
Uploaded by EdskoDeVries at 2021-03-17T18:05:59Z
Distributions NixOS:0.4.0.0
Downloads 293 total (12 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-03-17 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for recover-rtti-0.3.0.0

[back to package description]

recover-rtti

Recover run-time type information from the GHC heap. The key function in this library is

classify :: a -> Classifier a

which recovers type information about values about which we know nothing (in particular, no type class constraints). One example use case is the following anythingToString function:

anythingToString :: a -> String

We test that the result of anythingToString is equal to the result of regular show for a large range of data types (including user-defined ones that the library is not aware of). There are also other possible use cases; for example, it should be possible to define an anythingToJSON function.

Obviously there are limitations; the most important ones are:

  • UNPACKed fields are invisible to the library. This does not need to be a major issue though, when compiling code with -O0 fields are not unpacked. (https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/exts/pragmas.html?highlight=unpack#nounpack-pragma)
  • Record field names are not known, and so records are shown just using the constructor.

There may be other gotchas as well; this library is primarily intended for debugging.