package colibri2

  1. Overview
  2. Docs
package colibri2
Legend:
Library
Module
Module type
Parameter
Class
Class type
type flag
val register_flag : desc:(unit, unit, unit, unit, unit, unit) Stdlib.format6 -> string -> flag

Register a new flag. It is allowed to register twice the same flag

val register_info_flag : desc:(unit, unit, unit, unit, unit, unit) Stdlib.format6 -> string -> flag

Register a new info flag. It is allowed to register twice the same flag. Info flags are set by --debug-all and must not change the behaviour.

val list_flags : unit -> (string * flag * bool * (unit, unit, unit, unit, unit, unit) Stdlib.format6) list

List the known flags, the boolean indicate if it is an info flag

val lookup_flag : string -> flag

get the flag

val is_info_flag : string -> bool

test if the flag is an info flag

val flag_desc : string -> (unit, unit, unit, unit, unit, unit) Stdlib.format6

get the description of the flag

val _true : flag

a flag always true; can't be modified

val todo : flag

a flag always true; can't be modified should be used for temporary debugging message

val set_flag : flag -> unit

Modify the state of a flag

val unset_flag : flag -> unit
val toggle_flag : flag -> unit
val test_flag : flag -> bool

Return the state of the flag

val test_noflag : flag -> bool
val set_debug_formatter : Containers.Format.formatter -> unit

Set the formatter used when printing debug material

val get_debug_formatter : unit -> Containers.Format.formatter

Get the formatter used when printing debug material

val real_dprintf : ?nobox:unit -> ?ct:unit -> ('a, Containers.Format.formatter, unit) Stdlib.format -> 'a
val dprintf0 : ?nobox:unit -> ?ct:unit -> flag -> (unit, Containers.Format.formatter, unit) Stdlib.format -> unit

Print only if the flag is set

val dprintf1 : ?nobox:unit -> ?ct:unit -> flag -> ('a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'a -> unit

Print only if the flag is set

val dprintf2 : ?nobox:unit -> ?ct:unit -> flag -> ('b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf3 : ?nobox:unit -> ?ct:unit -> flag -> ('c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf4 : ?nobox:unit -> ?ct:unit -> flag -> ('d -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf5 : ?nobox:unit -> ?ct:unit -> flag -> ('e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf6 : ?nobox:unit -> ?ct:unit -> flag -> ('f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf7 : ?nobox:unit -> ?ct:unit -> flag -> ('g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf8 : ?nobox:unit -> ?ct:unit -> flag -> ('h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf9 : ?nobox:unit -> ?ct:unit -> flag -> ('i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf10 : ?nobox:unit -> ?ct:unit -> flag -> ('j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf11 : ?nobox:unit -> ?ct:unit -> flag -> ('k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf12 : ?nobox:unit -> ?ct:unit -> flag -> ('l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf13 : ?nobox:unit -> ?ct:unit -> flag -> ('m -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf14 : ?nobox:unit -> ?ct:unit -> flag -> ('n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintf15 : ?nobox:unit -> ?ct:unit -> flag -> ('o -> 'n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit, Containers.Format.formatter, unit) Stdlib.format -> 'o -> 'n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> unit

Print only if the flag is set

val dprintfn : ?nobox:unit -> ?ct:unit -> flag -> ('o -> 'n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> 'z, Containers.Format.formatter, unit) Stdlib.format -> 'o -> 'n -> 'm -> 'l -> 'k -> 'j -> 'i -> 'h -> 'g -> 'f -> 'e -> 'd -> 'c -> 'b -> 'a -> 'z

Print only if the flag is set

Print only if the flag is set

val stack_trace : flag

stack_trace flag

val noassert : bool

is -noassert set

module Args : sig ... end

Command line arguments

val stats : flag

Stats

type 'a stat
val register_stats : pp:'a Fmt.t -> name:string -> init:'a -> 'a stat
val modstats0 : 'a stat -> ('a -> 'a) -> unit
val modstats1 : 'a stat -> ('a -> 'b -> 'a) -> 'b -> unit
val modstats2 : 'a stat -> ('a -> 'b -> 'c -> 'a) -> 'b -> 'c -> unit
val register_stats_int : string -> int stat
val register_stats_time : string -> float stat
val incr : int stat -> unit
val decr : int stat -> unit
val get_stats : int stat -> int
val add_time_during : float stat -> (unit -> 'a) -> 'a
val print_stats : unit -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct