package ppx_minidebug

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

ppx_minidebug.runtime
- Minidebug_runtime
  - Debug_runtime
  - Flushing
    
    _
  - PrintBox
    
    _
  - PrintBox_runtime
  - Shared_config

Legend:
Library
Module
Module type
Parameter
Class
Class type

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).

Parameters

module _ : Shared_config

Signature

val close_log : fname:string -> start_lnum:int -> entry_id:int -> unit

val open_log : 
  fname:string ->
  start_lnum:int ->
  start_colnum:int ->
  end_lnum:int ->
  end_colnum:int ->
  message:string ->
  entry_id:int ->
  unit

val open_log_no_source : message:string -> entry_id:int -> unit

val log_value_sexp : 
  ?descr:string ->
  entry_id:int ->
  is_result:bool ->
  Sexplib0.Sexp.t ->
  unit

val log_value_pp : 
  ?descr:string ->
  entry_id:int ->
  pp:(Format.formatter -> 'a -> unit) ->
  is_result:bool ->
  'a ->
  unit

val log_value_show : 
  ?descr:string ->
  entry_id:int ->
  is_result:bool ->
  string ->
  unit

val log_value_printbox : entry_id:int -> PrintBox.t -> unit

val exceeds_max_nesting : unit -> bool

val exceeds_max_children : unit -> bool

val get_entry_id : unit -> int

val max_nesting_depth : int option ref

val max_num_children : int option ref

val global_prefix : string

val snapshot : unit -> unit

For PrintBox runtimes, outputs the current logging stack to the logging channel. If the logging channel supports that, an output following a snapshot will rewind the channel to the state prior to the snapshot. Does nothing for the Flushing runtimes.

val description : string

A description that should be sufficient to locate where the logs end up. If not configured explicitly, it will be some combination of: the global prefix, the file name or "stdout".