package pplumbing

You can search for identifiers within the package.

in-package search v0.2.0

pplumbing
- Library pplumbing.cmdlang-cmdliner-runner
  - Cmdlang_cmdliner_runner
- Library pplumbing.err
  - Err
    
    Exit_code
    
    For_test
    
    Private
    
    Style_renderer
    
    Logs_level
- Library pplumbing.log
  - Log
    
    Logs
- Library pplumbing.log-cli
  - Log_cli
    
    Config
- Library pplumbing.pp-tty
  - Pp_tty
    
    Ansi_color
    
    RGB8
    
    RGB24
    
    Style
    
    Staged
    
    Style
    
    Print_config
    
    To_string
- Sources
  - pplumbing.cmdlang-cmdliner-runner
    
    cmdlang_cmdliner_runner.ml
  - pplumbing.err
    
    err.ml
  - pplumbing.log
    
    log.ml
  - pplumbing.log-cli
    
    log_cli.ml
  - pplumbing.pp-tty
    
    ansi_color.ml
    
    pp_tty.ml
    
    pp_tty__.ml

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

Module `Err.Private`Source

Private is used by Err_config. We mean both libraries to work as companion libs. Note any of this can change without notice and without requiring a semver bump, so use at your own risk (or don't).

Sourceval am_running_test : bool ref

Sourceval reset_counts : unit -> unit

Sourceval reset_separator : unit -> unit

Sourcemodule Style_renderer : sig ... end

Compatibility with Fmt.

Sourceval style_renderer : Style_renderer.t ref

Sourcemodule Logs_level : sig ... end

Compatibility with Logs.

Source

val set_logs_level : 
  get:(unit -> Logs_level.t) ->
  set:(Logs_level.t -> unit) ->
  unit

Since Err does not depend on Logs, the Err and Logs levels must be set independently. However, this is done for you consistently if you are using Err_cli.

Sourceval warn_error : bool ref

Source

val set_logs_counts : 
  err_count:(unit -> int) ->
  warn_count:(unit -> int) ->
  unit

To avoid making this library depend on Logs we inject the dependency into the functions we need instead. To be called with Logs.err_count and Logs.warn_count.

package pplumbing

Module Err.PrivateSource

Module `Err.Private`Source