package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

A package that contains multiple base libraries used by the Octez suite

Install

dune-project

Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.1.tar.gz

sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d

sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/octez-libs.event-logging/Tezos_event_logging/Internal_event/Make/index.html

Module `Internal_event.Make`Source

Build an event from an event-definition.

Parameters

module E : EVENT_DEFINITION

Signature

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.

Source

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.