Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mjambon/dum
Print OCaml values based on their runtime representation
https://github.com/mjambon/dum
Last synced: 25 days ago
JSON representation
Print OCaml values based on their runtime representation
- Host: GitHub
- URL: https://github.com/mjambon/dum
- Owner: mjambon
- License: other
- Created: 2014-12-14T19:43:35.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T13:09:00.000Z (over 2 years ago)
- Last Synced: 2024-10-03T12:44:55.990Z (about 1 month ago)
- Language: OCaml
- Homepage:
- Size: 22.5 KB
- Stars: 30
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - dum
README
Dum
===
Purpose
-------
Inspecting arbitrary OCaml values for debugging or just for fun.
Cycles are detected and an additional limit on the size of the dump is
set by default. It is therefore safe to use for printing out
exceptions in error messages.
Closure fields and object fields are printed.
All the lazy values (forced or not) can be printed but this is optional.
Some forced lazy values will always be printed no matter what.
Installation
------------
```
$ opam update
$ opam install dum
```
Usage
-----
We do not recommend the use of this library in production code due to
its reliance on OCaml internals and unsafe memory access.
```ocaml
$ utop -require dum
# Dum.to_stdout (123, "abc", Not_found, [`A; `B 'x']);;
(123 "abc" object-7 () [ 65 (66 120) ])
```
A circular list is printed as follows:
```ocaml
# let rec cyc = 1 :: 2 :: 3 :: cyc;;
val cyc : int list = [1; 2; 3; ]
utop # Dum.to_stdout cyc;;
#0: (1 (2 (3 #0)))
```
First-class modules can be inspected as well. Here's what I get for the `Sys` module:
```ocaml
# module type Sys = module type of Sys;;
# Dum.to_stdout (module Sys : Sys);;
(
("/home/martin/.opam/4.05.0/bin/utop" "-require" "dum")
"/home/martin/.opam/4.05.0/bin/utop"
closure ()
(1)
"Unix"
1
1
0
0
64
63
0
144115188075855863
18014398509481983
#0: closure ()
-1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
#1: object1 ()
closure (#0 -6 #1)
"4.05.0"
closure ()
closure ()
)
```
See `dum.mli` for more information.
License
-------
GNU LGPL with exception on static linking, see file LICENSE.