package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Package contains no libraries

Build an event from an event-definition.

Parameters

module E : EVENT_DEFINITION

include EVENT_DEFINITION with type t = E.t

type t = E.t

val section : 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 : all_fields:bool -> block:bool -> Format.formatter -> t -> unit

val encoding : t Data_encoding.t

val level : level

Return the preferred level for a given event instance.

val emit : 
  ?section:Section.t ->
  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.