package ppx_minidebug

You can search for identifiers within the package.

in-package search v0.2.0

ppx_minidebug.runtime
- Minidebug_runtime
  - Debug_ch
    
    _
  - Debug_ch_no_time_tags
    
    _
  - Debug_runtime
  - Flushing
    
    _
  - Pp_format
    
    _
  - PrintBox
    
    _

Legend:
Library
Module
Module type
Parameter
Class
Class type

The functors creating a Debug_runtime module that ppx_minidebug requires.

module type Debug_ch = sig ... end

module Debug_ch (_ : sig ... end) : Debug_ch

Opens a file with the given path for appending. Debugging is time tagged.

module Debug_ch_no_time_tags (_ : sig ... end) : Debug_ch

Opens a file with the given path for appending. Debugging is not time tagged.

module type Debug_runtime = sig ... end

When using the ppx_minidebug syntax extension, provide a module called Debug_runtime with this signature in scope of the instrumented code.

module Pp_format (_ : Debug_ch) : Debug_runtime

The logged traces will be indented using OCaml's `Format` module.

module Flushing (_ : Debug_ch) : Debug_runtime

The output is flushed line-at-a-time, so no output should be lost if the traced program crashes. The logged traces are still indented, but if the values to print are multi-line, their formatting might be messy. The indentation is also smaller (half of PrintBox).

module PrintBox (_ : Debug_ch) : Debug_runtime

The logged traces will be pretty-printed as trees using the `printbox` package.