Module type Logs.LOG
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt
:DkSDKProject_DeclareAvailable(logs CONSTRAINT "= 0.7.0+dune2" FINDLIBS logs logs.cli logs.fmt logs.lwt logs.threaded logs.top) DkSDKProject_MakeAvailable(logs)
Add the
Findlib::logs
library to any desired targets insrc/*/CMakeLists.txt
:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::logs)
Click your IDE's
Build
button
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install logs.0.7.0+dune2
Edit your
dune-project
and add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (logs (>= 0.7.0+dune2))))
Then run:
dune build *.opam # if this fails, run: dune build
Edit your
<package>.opam
file and add:depends: [ # ... existing dependencies ... "logs" {>= "0.7.0+dune2"} ]
Then run:
opam install . --deps-only
FINALLY, add the logs
library to any desired (library)
and/or (executable)
targets in your **/dune
files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
logs))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
logs))
Log functions
val
app :
'a
log
app
is msg App
.
val
err :
'a
log
err
is msg Error
.
val
warn :
'a
log
warn
is msg Warning
.
val
info :
'a
log
info
is msg Info
.
val
debug :
'a
log
debug
is msg Debug
.
Logging result
value Error
s
val
on_error : ``?level:
level
->
``?header:string
->
``?tags:
Tag.set
->
``pp:``(
Stdlib.Format.formatter
->
'b
->
unit)``
->
``use:``(
'b
->
'a
)``
->
``(
'a
,
'b
)``
result
->
'a
See Logs.on_error
.
val
on_error_msg : ``?level:
level
->
``?header:string
->
``?tags:
Tag.set
->
``use:``(``unit
->
'a
)``
->
``(
'a
, ``[ ```
Msg of string ``` ])
[
result](../../ocaml/Stdlib/#type-result)
`->
'a\
See Logs.on_error_msg
.