package binsec
Install
dune-project
Dependency
Authors
-
AAdel Djoudi
-
BBenjamin Farinier
-
CChakib Foulani
-
DDorian Lesbre
-
FFrédéric Recoules
-
GGuillaume Girol
-
JJosselin Feist
-
LLesly-Ann Daniel
-
MManh-Dung Nguyen
-
MMathéo Vergnolle
-
MMathilde Ollivier
-
MMatthieu Lemerre
-
OOlivier Nicole
-
RRichard Bonichon
-
RRobin David
-
SSébastien Bardin
-
SSoline Ducousso
-
TTa Thanh Dinh
-
YYaëlle Vinçont
Maintainers
Sources
sha256=11c5335f413cca0773ec8fd7804adeb2ae960fff834c35f7eb510c43dad51092
sha512=7d706de9c98a97017ef07d317552917f76ff771b95d1cf76ad6986558244a822ea72bdc89981689fb9b63837468ef378f30ff659a7e2578d0285ce5f037b6022
doc/binsec.sse/Se/Sse_options/Logger/index.html
Module Sse_options.Logger
Channels
val fatal_channel : channelval error_channel : channelval result_channel : channelval warning_channel : channelval info_channel : channelval debug_channel : channelThese predefined channels are flushed after each call and a newline character is inserted.
val fatal : ?e:exn -> ('a, Format.formatter, unit, 'b) format4 -> 'aFor messages that show a fatal failure, In this case, you should not be able to continue and exit code should follow the emission. Use error otherwise.
val error : ('a, Format.formatter, unit) format -> 'aFor error messages only.
val result : ('a, Format.formatter, unit) format -> 'aFor important results that will be displayed
val warning : ?level:int -> ('a, Format.formatter, unit) format -> 'aFor warning messages.
val info : ?level:int -> ('a, Format.formatter, unit) format -> 'aAny info that should be displayed
val debug : ?level:int -> ('a, Format.formatter, unit) format -> 'adebug ~level:n msg will be displayed if at least level n + 1 debug is activated
val fdebug :
?level:int ->
(unit -> (unit, Format.formatter, unit) format) ->
unitfdebug ~level f acts like like debug ~level msg where msg = f () but lazily evaluates its argument. Use fdebug instead of debug if you need to print values that might be hard to compute (and that you therefore compute inside the closure).
set_tagged_entry Print channel identifiers, like warning for the warning channel, in front of messages to explicit their origins.
If might not be necessary if you use colors for example.
Set logger to display only messages from that channel and those with higher loglevels.
Valid arguments in increasing order of loglevels are : "debug", "info", "warning", "error", "fatal"/"result".
You cannot turn off fatal_channel or result_channel.
val cli_handler : Arg.specval channel_set_color : bool -> channel -> unitset_channel_color b chan activates (if b is true) or deactivates (if b is false) the emission of ANSI color tags for terminal.
You might want to deactivate the feature if you plan on analyzing the log in a file for example.
val channel_get_color : channel -> boolActivate color tags rendering on all outputs.
In your format strings, tags of the form "\@\{<color>format\@\}" will thus be interpreted.
color can be any of the following:
- black
- darkgray
- blue
- lightblue
- green
- lightgreen,
- cyan
- lightcyan
- red
- lightred
- purple
- lightpurple
- brown
- yellow
- lightgray
- white
format is any format string recognized by Format. For example, after activating color tags Format.printf "\@\{<purple>Hello!\@\}" will write "Hello!" in purple if your terminal has such features.