Library
Module
Module type
Parameter
Class
Class type
Sources.
type t = src
The type for log sources.
val create : ?doc:string -> string -> src
create ?doc name
is a new log source. name
is the name of the source; it doesn't need to be unique but it is good practice to prefix the name with the name of your package or library (e.g. "mypkg.network"
). doc
is a documentation string describing the source, defaults to "undocumented"
. The initial reporting level of the source is defined by Logs.level
.
val name : src -> string
name
is src
's name.
val doc : src -> string
doc src
is src
's documentation string.
set_level src l
sets the report level of src
to l
. Only applications should use this function directly, see usage conventions.
val pp : Stdlib.Format.formatter -> src -> unit
pp ppf src
prints an unspecified representation of src
on ppf
.
val list : unit -> src list
list ()
is the current exisiting source list.