package ppx_minidebug

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

ppx_minidebug
- Library ppx_minidebug
  - Ppx_minidebug
    
    A
- Library ppx_minidebug.runtime
  - Minidebug_runtime
    
    Shared_config
    
    Debug_runtime
    
    Flushing
    
    PrintBox_runtime
    
    PrintBox
- Sources
  - ppx_minidebug
    
    ppx_minidebug.ml
  - ppx_minidebug.runtime
    
    dynarray.ml
    
    minidebug_runtime.ml
    
    minidebug_runtime__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Minidebug_runtime.PrintBox`Source

The logged traces will be pretty-printed as trees using the `printbox` package. This logger supports conditionally disabling a particular nesting of the logs, regardless of where in the nesting level no_debug_if is called.

Parameters

module _ : Shared_config

Signature

include Debug_runtime

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

Source

val open_log : 
  fname:string ->
  start_lnum:int ->
  start_colnum:int ->
  end_lnum:int ->
  end_colnum:int ->
  message:string ->
  entry_id:int ->
  log_level:int ->
  [ `Diagn | `Debug | `Track ] ->
  unit

Source

val open_log_no_source : 
  message:string ->
  entry_id:int ->
  log_level:int ->
  [ `Diagn | `Debug | `Track ] ->
  unit

Source

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

Source

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

Source

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

Sourceval log_value_printbox : entry_id:int -> log_level:int -> PrintBox.t -> unit

Sourceval exceeds_max_nesting : unit -> bool

Sourceval exceeds_max_children : unit -> bool

Sourceval get_entry_id : unit -> int

Sourceval max_nesting_depth : int option ref

Sourceval max_num_children : int option ref

Sourceval global_prefix : string

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

Sourceval finish_and_cleanup : unit -> unit

Snapshots any pending logs and closes any open files. This should be called at the end of the program to ensure all logs are properly flushed and files are closed. Do not call this function if there is a chance that the backend will be used again.

Sourceval no_debug_if : bool -> unit

For PrintBox runtimes, when passed true within the scope of a log subtree, disables the logging of this subtree and its subtrees. Does not do anything when passed false (no_debug_if false does not re-enable the log). Does nothing for the Flushing runtimes.

Sourceval log_level : int ref

The runtime log level.

The log levels are used both at compile time, and for the PrintBox runtime. Not logging at compile time means the corresponding logging code is not generated; not logging at runtime means the logging state is not updated.

Sourceval config : printbox_config

package ppx_minidebug

Module Minidebug_runtime.PrintBoxSource

Parameters

Signature

Module `Minidebug_runtime.PrintBox`Source