package tezos-workers

You can search for identifiers within the package.

in-package search v0.2.0

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

Module `Logger.LogEvent`

include Tezos_event_logging.Internal_event.EVENT_DEFINITION with type t = t

type t = t

val section : Tezos_event_logging.Internal_event.Section.t option

Defines an optional section for the event.

Warning None is only for legacy events and should not be used in new code.

val name : string

Defines the identifier for the event. Names should be unique and are restricted to alphanumeric characters or ".@-_+=,~".

val doc : string

A display-friendly text which describes what the event means.

val pp : short:bool -> Format.formatter -> t -> unit

val encoding : t Data_encoding.t

val level : t -> Tezos_event_logging.Internal_event.level

Return the preferred level for a given event instance.

val emit : 
  ?section:Tezos_event_logging.Internal_event.Section.t ->
  (unit -> t) ->
  unit Tezos_error_monad.Error_monad.tzresult Lwt.t

Output an event of type t, if no sinks are listening the function won't be applied.