diff --git a/dev/catapult-client/Catapult_client/.dummy b/dev/catapult-client/Catapult_client/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dev/catapult-client/Catapult_client/index.html b/dev/catapult-client/Catapult_client/index.html index dd44138..0c0779e 100644 --- a/dev/catapult-client/Catapult_client/index.html +++ b/dev/catapult-client/Catapult_client/index.html @@ -1,2 +1,2 @@ -Catapult_client (catapult-client.Catapult_client)

Module Catapult_client

Backend for Catapult, using a connection to the daemon.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
module Endpoint_address = Catapult_utils.Endpoint_address
val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit

Must be called before the setup.

val get_trace_id : unit -> string
val default_endpoint : Endpoint_address.t
val get_endpoint : unit -> Endpoint_address.t
val set_endpoint : Endpoint_address.t -> unit

Must be called before the setup.

val set_tcp_endpoint : string -> int -> unit
val set_ipc_endpoint : string -> unit
\ No newline at end of file +Catapult_client (catapult-client.Catapult_client)

Module Catapult_client

Backend for Catapult, using a connection to the daemon.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
module Endpoint_address = Catapult_utils.Endpoint_address
val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit

Must be called before the setup.

val get_trace_id : unit -> string
val default_endpoint : Endpoint_address.t
val get_endpoint : unit -> Endpoint_address.t
val set_endpoint : Endpoint_address.t -> unit

Must be called before the setup.

val set_tcp_endpoint : string -> int -> unit
val set_ipc_endpoint : string -> unit
\ No newline at end of file diff --git a/dev/catapult-client/index.html b/dev/catapult-client/index.html index 862b973..f6849d5 100644 --- a/dev/catapult-client/index.html +++ b/dev/catapult-client/index.html @@ -1,2 +1,2 @@ -index (catapult-client.index)

catapult-client index

Library catapult-client

The entry point of this library is the module: Catapult_client.

\ No newline at end of file +index (catapult-client.index)

catapult-client index

Library catapult-client

The entry point of this library is the module: Catapult_client.

\ No newline at end of file diff --git a/dev/catapult-daemon/index.html b/dev/catapult-daemon/index.html index 462b76d..8c62fd9 100644 --- a/dev/catapult-daemon/index.html +++ b/dev/catapult-daemon/index.html @@ -1,2 +1,2 @@ -index (catapult-daemon.index)

catapult-daemon index

\ No newline at end of file +index (catapult-daemon.index)

catapult-daemon index

\ No newline at end of file diff --git a/dev/catapult-file/Catapult_file/.dummy b/dev/catapult-file/Catapult_file/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dev/catapult-file/Catapult_file/index.html b/dev/catapult-file/Catapult_file/index.html deleted file mode 100644 index 59510ac..0000000 --- a/dev/catapult-file/Catapult_file/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Catapult_file (catapult-file.Catapult_file)

Module Catapult_file

Logs to a file, if activated.

Profiling is enabled if setup is called, and if the environment variable "TRACE" is set to "1" or "true", or enable was called. The trace is emitted in the file "trace.json" in the directory where the program is launched.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
val enable : unit -> unit

Enable manually

val set_file : string -> unit

Set output file. Call before setup.

\ No newline at end of file diff --git a/dev/catapult-file/index.html b/dev/catapult-file/index.html deleted file mode 100644 index 8375553..0000000 --- a/dev/catapult-file/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -index (catapult-file.index)

catapult-file index

Library catapult-file

The entry point of this library is the module: Catapult_file.

\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/.dummy b/dev/catapult-sqlite/Catapult_sqlite/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/argument-1-Arg/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/argument-1-Arg/index.html index b78bd62..df8ef69 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/argument-1-Arg/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/argument-1-Arg/index.html @@ -1,2 +1,2 @@ -Arg (catapult-sqlite.Catapult_sqlite.Backend.Make.Arg)

Parameter Make.Arg

val writer : Writer.t
\ No newline at end of file +Arg (catapult-sqlite.Catapult_sqlite.Backend.Make.Arg)

Parameter Make.Arg

val writer : Writer.t
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html index d457abc..aded768 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html @@ -1,5 +1,5 @@ -Make (catapult-sqlite.Catapult_sqlite.Backend.Make)

Module Backend.Make

Parameters

module Arg : ARG

Signature

val emit : +Make (catapult-sqlite.Catapult_sqlite.Backend.Make)

Module Backend.Make

Parameters

module Arg : ARG

Signature

val emit : id:string option -> name:string -> ph:Catapult.Event_type.t -> diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html index 7fc1379..d5441f2 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html @@ -1,2 +1,2 @@ -Backend (catapult-sqlite.Catapult_sqlite.Backend)

Module Catapult_sqlite.Backend

module type ARG = sig ... end
\ No newline at end of file +Backend (catapult-sqlite.Catapult_sqlite.Backend)

Module Catapult_sqlite.Backend

module type ARG = sig ... end
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/module-type-ARG/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/module-type-ARG/index.html index c2cf2f7..a7e8cd8 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/module-type-ARG/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/module-type-ARG/index.html @@ -1,2 +1,2 @@ -ARG (catapult-sqlite.Catapult_sqlite.Backend.ARG)

Module type Backend.ARG

val writer : Writer.t
\ No newline at end of file +ARG (catapult-sqlite.Catapult_sqlite.Backend.ARG)

Module type Backend.ARG

val writer : Writer.t
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html b/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html index cfa1996..cd469f8 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html @@ -1,2 +1,2 @@ -Ev_to_json (catapult-sqlite.Catapult_sqlite.Ev_to_json)

Module Catapult_sqlite.Ev_to_json

val to_json : Stdlib.Buffer.t -> Catapult_utils.Ser.Event.t -> string
\ No newline at end of file +Ev_to_json (catapult-sqlite.Catapult_sqlite.Ev_to_json)

Module Catapult_sqlite.Ev_to_json

val to_json : Stdlib.Buffer.t -> Catapult_utils.Ser.Event.t -> string
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html b/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html index b480aec..ed032c0 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html @@ -1,5 +1,5 @@ -Writer (catapult-sqlite.Catapult_sqlite.Writer)

Module Catapult_sqlite.Writer

type t
val create : +Writer (catapult-sqlite.Catapult_sqlite.Writer)

Module Catapult_sqlite.Writer

type t
val create : ?sync:[ `OFF | `NORMAL | `FULL ] -> ?append:bool -> ?file:string -> diff --git a/dev/catapult-sqlite/Catapult_sqlite/index.html b/dev/catapult-sqlite/Catapult_sqlite/index.html index 4911203..51ddc5b 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/index.html @@ -1,2 +1,2 @@ -Catapult_sqlite (catapult-sqlite.Catapult_sqlite)

Module Catapult_sqlite

Backend that writes directly to a Sqlite database.

The database path is either directly provided with "TRACE_DB" or set_file, or it's a file named after the trace ID in the directory set by set_dir (or the default directory otherwise).

The trace ID is determined by "TRACE_ID" if present, otherwise auto-generated or set via set_trace_id.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
val set_sqlite_sync : [ `OFF | `NORMAL | `FULL ] -> unit

Set level of crash safety for sqlite. See Writer.create for more details.

val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit
val get_trace_id : unit -> string
val set_multiproc : bool -> unit

Multiprocess mode? If true, then the file will not be truncated.

val set_dir : string -> unit

Set directory in which to store the database by its trace ID.

val set_file : string -> unit

Set database path to use. If not specified, it will be picked from the trace ID, and the directory set_dir.

module Writer : sig ... end
module Backend : sig ... end
module Ev_to_json : sig ... end
\ No newline at end of file +Catapult_sqlite (catapult-sqlite.Catapult_sqlite)

Module Catapult_sqlite

Backend that writes directly to a Sqlite database.

The database path is either directly provided with "TRACE_DB" or set_file, or it's a file named after the trace ID in the directory set by set_dir (or the default directory otherwise).

The trace ID is determined by "TRACE_ID" if present, otherwise auto-generated or set via set_trace_id.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
val set_sqlite_sync : [ `OFF | `NORMAL | `FULL ] -> unit

Set level of crash safety for sqlite. See Writer.create for more details.

val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit
val get_trace_id : unit -> string
val set_multiproc : bool -> unit

Multiprocess mode? If true, then the file will not be truncated.

val set_dir : string -> unit

Set directory in which to store the database by its trace ID.

val set_file : string -> unit

Set database path to use. If not specified, it will be picked from the trace ID, and the directory set_dir.

module Writer : sig ... end
module Backend : sig ... end
module Ev_to_json : sig ... end
\ No newline at end of file diff --git a/dev/catapult-sqlite/index.html b/dev/catapult-sqlite/index.html index 27594fd..c325b10 100644 --- a/dev/catapult-sqlite/index.html +++ b/dev/catapult-sqlite/index.html @@ -1,2 +1,2 @@ -index (catapult-sqlite.index)

catapult-sqlite index

Library catapult-sqlite

The entry point of this library is the module: Catapult_sqlite.

\ No newline at end of file +index (catapult-sqlite.index)

catapult-sqlite index

Library catapult-sqlite

The entry point of this library is the module: Catapult_sqlite.

\ No newline at end of file diff --git a/dev/catapult/Catapult/.dummy b/dev/catapult/Catapult/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dev/catapult/Catapult/Arg/index.html b/dev/catapult/Catapult/Arg/index.html index bd3918f..864fa56 100644 --- a/dev/catapult/Catapult/Arg/index.html +++ b/dev/catapult/Catapult/Arg/index.html @@ -1,2 +1,2 @@ -Arg (catapult.Catapult.Arg)

Module Catapult.Arg

Custom arguments.

These arguments can be emitted as part of most events, and can be used to store custom data, debug messages, etc.

type t = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]

Custum argument for events, spans, instants, etc.

\ No newline at end of file +Arg (catapult.Catapult.Arg)

Module Catapult.Arg

Custom arguments.

These arguments can be emitted as part of most events, and can be used to store custom data, debug messages, etc.

type t = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]

Custum argument for events, spans, instants, etc.

\ No newline at end of file diff --git a/dev/catapult/Catapult/Event_type/index.html b/dev/catapult/Catapult/Event_type/index.html index ff34836..ac1dc88 100644 --- a/dev/catapult/Catapult/Event_type/index.html +++ b/dev/catapult/Catapult/Event_type/index.html @@ -1,2 +1,2 @@ -Event_type (catapult.Catapult.Event_type)

Module Catapult.Event_type

Event types.

type t =
  1. | B
    (*

    begin

    *)
  2. | E
    (*

    end

    *)
  3. | X
    (*

    begin+end

    *)
  4. | I
    (*

    instant

    *)
  5. | C
    (*

    counter

    *)
  6. | P
    (*

    sample

    *)
  7. | A_b
    (*

    async: begin 'b'

    *)
  8. | A_n
    (*

    async: snapshot 'n'

    *)
  9. | A_e
    (*

    async: end 'e'

    *)
  10. | F_s
    (*

    flow: start 's'

    *)
  11. | F_t
    (*

    flow: step 't'

    *)
  12. | F_f
    (*

    flow: end 'f'

    *)
  13. | N
    (*

    object: created

    *)
  14. | O
    (*

    object: shapshot

    *)
  15. | D
    (*

    object: destroyed

    *)
  16. | M
    (*

    metadata

    *)
val to_char : t -> char
val of_char : char -> t
\ No newline at end of file +Event_type (catapult.Catapult.Event_type)

Module Catapult.Event_type

Event types.

type t =
  1. | B
    (*

    begin

    *)
  2. | E
    (*

    end

    *)
  3. | X
    (*

    begin+end

    *)
  4. | I
    (*

    instant

    *)
  5. | C
    (*

    counter

    *)
  6. | P
    (*

    sample

    *)
  7. | A_b
    (*

    async: begin 'b'

    *)
  8. | A_n
    (*

    async: snapshot 'n'

    *)
  9. | A_e
    (*

    async: end 'e'

    *)
  10. | F_s
    (*

    flow: start 's'

    *)
  11. | F_t
    (*

    flow: step 't'

    *)
  12. | F_f
    (*

    flow: end 'f'

    *)
  13. | N
    (*

    object: created

    *)
  14. | O
    (*

    object: shapshot

    *)
  15. | D
    (*

    object: destroyed

    *)
  16. | M
    (*

    metadata

    *)
val to_char : t -> char
val of_char : char -> t
\ No newline at end of file diff --git a/dev/catapult/Catapult/Nil_impl/index.html b/dev/catapult/Catapult/Nil_impl/index.html index 905b107..fdd006e 100644 --- a/dev/catapult/Catapult/Nil_impl/index.html +++ b/dev/catapult/Catapult/Nil_impl/index.html @@ -1,2 +1,2 @@ -Nil_impl (catapult.Catapult.Nil_impl)

Module Catapult.Nil_impl

Nil implementation.

This does not setup any backend. It can be useful for conditionally setting up an implementation, like using a "select" rule in dune.

val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
\ No newline at end of file +Nil_impl (catapult.Catapult.Nil_impl)

Module Catapult.Nil_impl

Nil implementation.

This does not setup any backend. It can be useful for conditionally setting up an implementation, like using a "select" rule in dune.

val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/Control/index.html b/dev/catapult/Catapult/Tracing/Control/index.html index 72c2ed2..0819199 100644 --- a/dev/catapult/Catapult/Tracing/Control/index.html +++ b/dev/catapult/Catapult/Tracing/Control/index.html @@ -1,2 +1,2 @@ -Control (catapult.Catapult.Tracing.Control)

Module Tracing.Control

Controls the current backend.

val setup : backend option -> unit
val teardown : unit -> unit
\ No newline at end of file +Control (catapult.Catapult.Tracing.Control)

Module Tracing.Control

Controls the current backend.

val setup : backend option -> unit
val teardown : unit -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/Syntax/index.html b/dev/catapult/Catapult/Tracing/Syntax/index.html index a6ef8bb..e3f9909 100644 --- a/dev/catapult/Catapult/Tracing/Syntax/index.html +++ b/dev/catapult/Catapult/Tracing/Syntax/index.html @@ -1,2 +1,2 @@ -Syntax (catapult.Catapult.Tracing.Syntax)

Module Tracing.Syntax

val let@ : ('a -> 'b) -> 'a -> 'b
\ No newline at end of file +Syntax (catapult.Catapult.Tracing.Syntax)

Module Tracing.Syntax

val let@ : ('a -> 'b) -> 'a -> 'b
\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/index.html b/dev/catapult/Catapult/Tracing/index.html index 9b4976f..f973877 100644 --- a/dev/catapult/Catapult/Tracing/index.html +++ b/dev/catapult/Catapult/Tracing/index.html @@ -1,5 +1,5 @@ -Tracing (catapult.Catapult.Tracing)

Module Catapult.Tracing

Profiling probes.

This is the main API. The user can insert probes into their code, and at runtime, these probes will use the Backend (if present) to emit tracing events to be replayed later. If no backend is present, the probes will do nothing.

type backend = (module Catapult__.Backend.S)
type arg = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]
type 'a emit_fun_base = +Tracing (catapult.Catapult.Tracing)

Module Catapult.Tracing

Profiling probes.

This is the main API. The user can insert probes into their code, and at runtime, these probes will use the Backend (if present) to emit tracing events to be replayed later. If no backend is present, the probes will do nothing.

type backend = (module Catapult__.Backend.S)
type arg = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]
type 'a emit_fun_base = ?pid:int -> ?tid:int -> ?args:(string * arg) list -> diff --git a/dev/catapult/Catapult/index.html b/dev/catapult/Catapult/index.html index 36458bc..41f0012 100644 --- a/dev/catapult/Catapult/index.html +++ b/dev/catapult/Catapult/index.html @@ -1,2 +1,2 @@ -Catapult (catapult.Catapult)

Module Catapult

Catapult-based tracing.

A nice profiling format based on json, useful for visualizing what goes on. This library is the instrumentation part; see catapult-client, catapult-file, or use a custom BACKEND to actually record traces.

If a trace is obtained in, say, the file "trace.json.gz", it can be opened in chrome/chromium at "chrome://tracing".

Tracy can import (uncompressed) trace files with a nice native trace explorer.

See the documentation of TEF

module type BACKEND = sig ... end
module type IMPL = sig ... end
module Arg : sig ... end

Custom arguments.

module Control = Tracing.Control
module Event_type : sig ... end

Event types.

module Nil_impl : sig ... end

Nil implementation.

module Tracing : sig ... end

Profiling probes.

\ No newline at end of file +Catapult (catapult.Catapult)

Module Catapult

Catapult-based tracing.

A nice profiling format based on json, useful for visualizing what goes on. This library is the instrumentation part; see catapult-client, catapult-file, or use a custom BACKEND to actually record traces.

If a trace is obtained in, say, the file "trace.json.gz", it can be opened in chrome/chromium at "chrome://tracing".

Tracy can import (uncompressed) trace files with a nice native trace explorer.

See the documentation of TEF

module type BACKEND = sig ... end
module type IMPL = sig ... end
module Arg : sig ... end

Custom arguments.

module Control = Tracing.Control
module Event_type : sig ... end

Event types.

module Nil_impl : sig ... end

Nil implementation.

module Tracing : sig ... end

Profiling probes.

\ No newline at end of file diff --git a/dev/catapult/Catapult/module-type-BACKEND/index.html b/dev/catapult/Catapult/module-type-BACKEND/index.html index f3cd18b..5d1a5c6 100644 --- a/dev/catapult/Catapult/module-type-BACKEND/index.html +++ b/dev/catapult/Catapult/module-type-BACKEND/index.html @@ -1,5 +1,5 @@ -BACKEND (catapult.Catapult.BACKEND)

Module type Catapult.BACKEND

val emit : +BACKEND (catapult.Catapult.BACKEND)

Module type Catapult.BACKEND

val emit : id:string option -> name:string -> ph:Event_type.t -> diff --git a/dev/catapult/Catapult/module-type-IMPL/index.html b/dev/catapult/Catapult/module-type-IMPL/index.html index 23e7115..a204a2a 100644 --- a/dev/catapult/Catapult/module-type-IMPL/index.html +++ b/dev/catapult/Catapult/module-type-IMPL/index.html @@ -1,2 +1,2 @@ -IMPL (catapult.Catapult.IMPL)

Module type Catapult.IMPL

val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
\ No newline at end of file +IMPL (catapult.Catapult.IMPL)

Module type Catapult.IMPL

val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/.dummy b/dev/catapult/Catapult_utils/.dummy deleted file mode 100644 index e69de29..0000000 diff --git a/dev/catapult/Catapult_utils/Bare_encoding/Decode/index.html b/dev/catapult/Catapult_utils/Bare_encoding/Decode/index.html index 7b54688..f224f6c 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/Decode/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/Decode/index.html @@ -1,2 +1,2 @@ -Decode (catapult.Catapult_utils.Bare_encoding.Decode)

Module Bare_encoding.Decode

Decoders.

This module provides a decoder type Decode.t to hold the decoding state, along with functions to decode specific primitives.

type t
val of_input : input -> t

create input makes a decoder for the given input.

  • since 0.2
val of_string : ?off:int -> ?len:int -> string -> t

Decoder reading from the string.

  • parameter off

    initial offset in the string

  • parameter len

    length of the slice of the string

  • raises Invalid_arg

    if off,off+len is not a valid slice in the string.

  • since 0.2
val of_bytes : ?off:int -> ?len:int -> bytes -> t

See of_string

  • since 0.2
type 'a dec = t -> 'a

A decoder for values of type 'a. Decoders will raise Error to indicate failure.

val uint : t -> int64

Decode a varint-encoded unsigned integer

val int : t -> int64

Decode a varint-encoded integer

val u8 : t -> char
val u16 : t -> int
val u32 : t -> int32
val u64 : t -> int64
val i8 : t -> char
val i16 : t -> int
val i32 : t -> int32
val i64 : t -> int64
val bool : t -> bool
val f32 : t -> float
val f64 : t -> float
val string : t -> string
val data : t -> bytes
val data_of : size:int -> t -> bytes
val optional : 'a dec -> 'a option dec
\ No newline at end of file +Decode (catapult.Catapult_utils.Bare_encoding.Decode)

Module Bare_encoding.Decode

Decoders.

This module provides a decoder type Decode.t to hold the decoding state, along with functions to decode specific primitives.

type t
val of_input : input -> t

create input makes a decoder for the given input.

  • since 0.2
val of_string : ?off:int -> ?len:int -> string -> t

Decoder reading from the string.

  • parameter off

    initial offset in the string

  • parameter len

    length of the slice of the string

  • raises Invalid_arg

    if off,off+len is not a valid slice in the string.

  • since 0.2
val of_bytes : ?off:int -> ?len:int -> bytes -> t

See of_string

  • since 0.2
type 'a dec = t -> 'a

A decoder for values of type 'a. Decoders will raise Error to indicate failure.

val uint : t -> int64

Decode a varint-encoded unsigned integer

val int : t -> int64

Decode a varint-encoded integer

val u8 : t -> char
val u16 : t -> int
val u32 : t -> int32
val u64 : t -> int64
val i8 : t -> char
val i16 : t -> int
val i32 : t -> int32
val i64 : t -> int64
val bool : t -> bool
val f32 : t -> float
val f64 : t -> float
val string : t -> string
val data : t -> bytes
val data_of : size:int -> t -> bytes
val optional : 'a dec -> 'a option dec
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Bare_encoding/Encode/index.html b/dev/catapult/Catapult_utils/Bare_encoding/Encode/index.html index 1488b37..9a10ce6 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/Encode/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/Encode/index.html @@ -1,2 +1,2 @@ -Encode (catapult.Catapult_utils.Bare_encoding.Encode)

Module Bare_encoding.Encode

Encoder type and some encoding utils.

The type Encode.t is passed to type-specific encoders so they can serialize values into bytes. This module also provides a host of functions that encode specific types (mostly integers and strings) into the Encode.t.

type t

Encoding state.

val of_output : output -> t

Encoding state that writes into the given output.

  • since 0.2
val of_buffer : Stdlib.Buffer.t -> t

Encoding state that emits bytes into the given buffer. After using a type encoder on this encoder, the buffer will contain the bytes.

type 'a enc = t -> 'a -> unit

A type encoder for values of type 'a.

val uint : t -> int64 -> unit

Encode unsigned integers using the varint encoding

val int : t -> int64 -> unit

Encode signed integers using the varint encoding

val u8 : t -> char -> unit

Encode a single byte

val u16 : t -> int -> unit

Encode a two byte unsigned integers in little endian

val u32 : t -> int32 -> unit

Encode an unsigned int32 integer in little endian

val u64 : t -> int64 -> unit

Encode an unsigned int64 integer in little endian

val i8 : t -> char -> unit

Same as u8

val i16 : t -> int -> unit

Encode a two byte unsigned integers in little endian

val i32 : t -> int32 -> unit

Encode a int32 integer in little endian

val i64 : t -> int64 -> unit

Encode a int64 integer in little endian

val bool : t -> bool -> unit

Encode a boolean as a single byte 0 or 1.

val f64 : t -> float -> unit

Encode a float.

val string : t -> string -> unit

Encode a string, prefixed by its length

val data : t -> bytes -> unit

Encode a blob, prefixed by its length

val data_of : size:int -> t -> bytes -> unit

Encode a blob of fixed size.

  • raises Failure

    if the blob's length in bytes is not equal to size

val optional : 'a enc -> 'a option enc

Encode an optional value, as either 0 for None or 1 followed by the encoding of x for Some x.

\ No newline at end of file +Encode (catapult.Catapult_utils.Bare_encoding.Encode)

Module Bare_encoding.Encode

Encoder type and some encoding utils.

The type Encode.t is passed to type-specific encoders so they can serialize values into bytes. This module also provides a host of functions that encode specific types (mostly integers and strings) into the Encode.t.

type t

Encoding state.

val of_output : output -> t

Encoding state that writes into the given output.

  • since 0.2
val of_buffer : Stdlib.Buffer.t -> t

Encoding state that emits bytes into the given buffer. After using a type encoder on this encoder, the buffer will contain the bytes.

type 'a enc = t -> 'a -> unit

A type encoder for values of type 'a.

val uint : t -> int64 -> unit

Encode unsigned integers using the varint encoding

val int : t -> int64 -> unit

Encode signed integers using the varint encoding

val u8 : t -> char -> unit

Encode a single byte

val u16 : t -> int -> unit

Encode a two byte unsigned integers in little endian

val u32 : t -> int32 -> unit

Encode an unsigned int32 integer in little endian

val u64 : t -> int64 -> unit

Encode an unsigned int64 integer in little endian

val i8 : t -> char -> unit

Same as u8

val i16 : t -> int -> unit

Encode a two byte unsigned integers in little endian

val i32 : t -> int32 -> unit

Encode a int32 integer in little endian

val i64 : t -> int64 -> unit

Encode a int64 integer in little endian

val bool : t -> bool -> unit

Encode a boolean as a single byte 0 or 1.

val f64 : t -> float -> unit

Encode a float.

val string : t -> string -> unit

Encode a string, prefixed by its length

val data : t -> bytes -> unit

Encode a blob, prefixed by its length

val data_of : size:int -> t -> bytes -> unit

Encode a blob of fixed size.

  • raises Failure

    if the blob's length in bytes is not equal to size

val optional : 'a enc -> 'a option enc

Encode an optional value, as either 0 for None or 1 followed by the encoding of x for Some x.

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Bare_encoding/Pp/index.html b/dev/catapult/Catapult_utils/Bare_encoding/Pp/index.html index 171e286..7111991 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/Pp/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/Pp/index.html @@ -1,2 +1,2 @@ -Pp (catapult.Catapult_utils.Bare_encoding.Pp)

Module Bare_encoding.Pp

Pretty printer utils, using Format.

type 'a t = Stdlib.Format.formatter -> 'a -> unit

A pretty printer for values of type 'a

type 'a iter = ('a -> unit) -> unit
val unit : unit t
val int : int t
val int8 : char t
val int32 : int32 t
val int64 : int64 t
val float : float t
val bool : bool t
val string : string t
val data : bytes t
val option : 'a t -> 'a option t
val array : 'a t -> 'a array t
val iter : 'a t -> 'a iter t
val list : 'a t -> 'a list t
\ No newline at end of file +Pp (catapult.Catapult_utils.Bare_encoding.Pp)

Module Bare_encoding.Pp

Pretty printer utils, using Format.

type 'a t = Stdlib.Format.formatter -> 'a -> unit

A pretty printer for values of type 'a

type 'a iter = ('a -> unit) -> unit
val unit : unit t
val int : int t
val int8 : char t
val int32 : int32 t
val int64 : int64 t
val float : float t
val bool : bool t
val string : string t
val data : bytes t
val option : 'a t -> 'a option t
val array : 'a t -> 'a array t
val iter : 'a t -> 'a iter t
val list : 'a t -> 'a list t
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Bare_encoding/String_map/index.html b/dev/catapult/Catapult_utils/Bare_encoding/String_map/index.html index 6fefced..5cb49ec 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/String_map/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/String_map/index.html @@ -1,5 +1,5 @@ -String_map (catapult.Catapult_utils.Bare_encoding.String_map)

Module Bare_encoding.String_map

type key = Stdlib.String.t
type !'a t = 'a Stdlib__Map.Make(Stdlib.String).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : +String_map (catapult.Catapult_utils.Bare_encoding.String_map)

Module Bare_encoding.String_map

type key = Stdlib.String.t
type !'a t = 'a Stdlib__Map.Make(Stdlib.String).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> diff --git a/dev/catapult/Catapult_utils/Bare_encoding/index.html b/dev/catapult/Catapult_utils/Bare_encoding/index.html index a35ddf3..8a4991a 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/index.html @@ -1,5 +1,5 @@ -Bare_encoding (catapult.Catapult_utils.Bare_encoding)

Module Catapult_utils.Bare_encoding

BARE runtime library.

See the spec.

module String_map : sig ... end
module type INPUT = sig ... end
type input = (module INPUT)
module Decode : sig ... end

Decoders.

module type OUTPUT = sig ... end

Output

type output = (module OUTPUT)
module Encode : sig ... end

Encoder type and some encoding utils.

module Pp : sig ... end

Pretty printer utils, using Format.

val of_bytes_exn : ?off:int -> ?len:int -> 'a Decode.dec -> bytes -> 'a

of_bytes_exn dec bs uses dec to decode a value of type 'a from bytes stored in bs.

  • parameter off

    the initial offset in bs (default 0)

  • raises Decode.Error

    if decoding fails

val of_bytes : +Bare_encoding (catapult.Catapult_utils.Bare_encoding)

Module Catapult_utils.Bare_encoding

BARE runtime library.

See the spec.

module String_map : sig ... end
module type INPUT = sig ... end
type input = (module INPUT)
module Decode : sig ... end

Decoders.

module type OUTPUT = sig ... end

Output

type output = (module OUTPUT)
module Encode : sig ... end

Encoder type and some encoding utils.

module Pp : sig ... end

Pretty printer utils, using Format.

val of_bytes_exn : ?off:int -> ?len:int -> 'a Decode.dec -> bytes -> 'a

of_bytes_exn dec bs uses dec to decode a value of type 'a from bytes stored in bs.

  • parameter off

    the initial offset in bs (default 0)

  • raises Decode.Error

    if decoding fails

val of_bytes : ?off:int -> ?len:int -> 'a Decode.dec -> diff --git a/dev/catapult/Catapult_utils/Bare_encoding/module-type-INPUT/index.html b/dev/catapult/Catapult_utils/Bare_encoding/module-type-INPUT/index.html index 2bd432f..946083e 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/module-type-INPUT/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/module-type-INPUT/index.html @@ -1,2 +1,2 @@ -INPUT (catapult.Catapult_utils.Bare_encoding.INPUT)

Module type Bare_encoding.INPUT

Input type

An input is a source of bytes, used to decode.

val read_byte : unit -> char

Read a single byte.

  • raises Invalid_argument

    if input is exhausted

val read_i16 : unit -> int

Read 2 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_i32 : unit -> int32

Read 4 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_i64 : unit -> int64

Read 8 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_exact : bytes -> int -> int -> unit

read_exact buf i len reads len bytes into buf, starting at offset i

  • raises Invalid_argument

    if input has less than len bytes

\ No newline at end of file +INPUT (catapult.Catapult_utils.Bare_encoding.INPUT)

Module type Bare_encoding.INPUT

Input type

An input is a source of bytes, used to decode.

val read_byte : unit -> char

Read a single byte.

  • raises Invalid_argument

    if input is exhausted

val read_i16 : unit -> int

Read 2 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_i32 : unit -> int32

Read 4 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_i64 : unit -> int64

Read 8 bytes, in little endian.

  • raises Invalid_argument

    if input is exhausted

val read_exact : bytes -> int -> int -> unit

read_exact buf i len reads len bytes into buf, starting at offset i

  • raises Invalid_argument

    if input has less than len bytes

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Bare_encoding/module-type-OUTPUT/index.html b/dev/catapult/Catapult_utils/Bare_encoding/module-type-OUTPUT/index.html index 6e7ae10..903281d 100644 --- a/dev/catapult/Catapult_utils/Bare_encoding/module-type-OUTPUT/index.html +++ b/dev/catapult/Catapult_utils/Bare_encoding/module-type-OUTPUT/index.html @@ -1,2 +1,2 @@ -OUTPUT (catapult.Catapult_utils.Bare_encoding.OUTPUT)

Module type Bare_encoding.OUTPUT

Output

An output is a sink where one can write bytes to encode data to BARE.

val write_byte : char -> unit

Write a single byte.

val write_i16 : int -> unit

Write 2 bytes, in little endian.

val write_i32 : int32 -> unit

Write 4 bytes, in little endian.

val write_i64 : int64 -> unit

Write 8 bytes, in little endian.

val write_exact : bytes -> int -> int -> unit

write_exact b i len writes the slice of length len of b starting at i.

val flush : unit -> unit

Non specified hint that the data may be flushed onto the disk or network. Doing nothing is acceptable when this makes no sense (e.g. when writing to a Buffer.t).

\ No newline at end of file +OUTPUT (catapult.Catapult_utils.Bare_encoding.OUTPUT)

Module type Bare_encoding.OUTPUT

Output

An output is a sink where one can write bytes to encode data to BARE.

val write_byte : char -> unit

Write a single byte.

val write_i16 : int -> unit

Write 2 bytes, in little endian.

val write_i32 : int32 -> unit

Write 4 bytes, in little endian.

val write_i64 : int64 -> unit

Write 8 bytes, in little endian.

val write_exact : bytes -> int -> int -> unit

write_exact b i len writes the slice of length len of b starting at i.

val flush : unit -> unit

Non specified hint that the data may be flushed onto the disk or network. Doing nothing is acceptable when this makes no sense (e.g. when writing to a Buffer.t).

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Endpoint_address/index.html b/dev/catapult/Catapult_utils/Endpoint_address/index.html index 76daf7e..d911bfe 100644 --- a/dev/catapult/Catapult_utils/Endpoint_address/index.html +++ b/dev/catapult/Catapult_utils/Endpoint_address/index.html @@ -1,2 +1,2 @@ -Endpoint_address (catapult.Catapult_utils.Endpoint_address)

Module Catapult_utils.Endpoint_address

Address for the daemon

type t =
  1. | Unix of string
  2. | Tcp of string * int
val to_string : t -> string
val of_string : string -> t option
val of_string_exn : string -> t
val default : t

Default address.

\ No newline at end of file +Endpoint_address (catapult.Catapult_utils.Endpoint_address)

Module Catapult_utils.Endpoint_address

Address for the daemon

type t =
  1. | Unix of string
  2. | Tcp of string * int
val to_string : t -> string
val of_string : string -> t option
val of_string_exn : string -> t
val default : t

Default address.

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Gc_stats/index.html b/dev/catapult/Catapult_utils/Gc_stats/index.html index 363fc46..db38010 100644 --- a/dev/catapult/Catapult_utils/Gc_stats/index.html +++ b/dev/catapult/Catapult_utils/Gc_stats/index.html @@ -1,2 +1,2 @@ -Gc_stats (catapult.Catapult_utils.Gc_stats)

Module Catapult_utils.Gc_stats

val set_gc_interval_us : float -> unit

Set the interval, in microseconds, between 2 successive gathering of GC statistics, to be emitted as catapult counters.

val maybe_emit : now:float -> pid:int -> unit -> unit

This checks whether it has been long enough since we last emitted counters for the GC. If it has, then it emits the event and resets the clock.

  • parameter now

    latest timestamp in microseconds (See Catapult.Clock.now_us)

  • parameter pid

    PID of the current process

\ No newline at end of file +Gc_stats (catapult.Catapult_utils.Gc_stats)

Module Catapult_utils.Gc_stats

val set_gc_interval_us : float -> unit

Set the interval, in microseconds, between 2 successive gathering of GC statistics, to be emitted as catapult counters.

val maybe_emit : now:float -> pid:int -> unit -> unit

This checks whether it has been long enough since we last emitted counters for the GC. If it has, then it emits the event and resets the clock.

  • parameter now

    latest timestamp in microseconds (See Catapult.Clock.now_us)

  • parameter pid

    PID of the current process

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Json_out/index.html b/dev/catapult/Catapult_utils/Json_out/index.html index 5bd7677..6a7f461 100644 --- a/dev/catapult/Catapult_utils/Json_out/index.html +++ b/dev/catapult/Catapult_utils/Json_out/index.html @@ -1,5 +1,5 @@ -Json_out (catapult.Catapult_utils.Json_out)

Module Catapult_utils.Json_out

Basic output of json values to a buffer

val char : Stdlib.Buffer.t -> char -> unit
val raw_string : Stdlib.Buffer.t -> string -> unit
val int : Stdlib.Buffer.t -> int -> unit
val int64 : Stdlib.Buffer.t -> int64 -> unit
val float : Stdlib.Buffer.t -> float -> unit
val bool : Stdlib.Buffer.t -> bool -> unit
val null : Stdlib.Buffer.t -> unit
val str_val : Stdlib.Buffer.t -> string -> unit
val arg : +Json_out (catapult.Catapult_utils.Json_out)

Module Catapult_utils.Json_out

Basic output of json values to a buffer

val char : Stdlib.Buffer.t -> char -> unit
val raw_string : Stdlib.Buffer.t -> string -> unit
val int : Stdlib.Buffer.t -> int -> unit
val int64 : Stdlib.Buffer.t -> int64 -> unit
val float : Stdlib.Buffer.t -> float -> unit
val bool : Stdlib.Buffer.t -> bool -> unit
val null : Stdlib.Buffer.t -> unit
val str_val : Stdlib.Buffer.t -> string -> unit
val arg : Stdlib.Buffer.t -> [< `Bool of bool | `Float of float diff --git a/dev/catapult/Catapult_utils/Ser/Arg/index.html b/dev/catapult/Catapult_utils/Ser/Arg/index.html index a8ab22e..b562121 100644 --- a/dev/catapult/Catapult_utils/Ser/Arg/index.html +++ b/dev/catapult/Catapult_utils/Ser/Arg/index.html @@ -1,2 +1,2 @@ -Arg (catapult.Catapult_utils.Ser.Arg)

Module Ser.Arg

type t = {
  1. key : string;
  2. value : Arg_value.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Arg (catapult.Catapult_utils.Ser.Arg)

Module Ser.Arg

type t = {
  1. key : string;
  2. value : Arg_value.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Arg_value/index.html b/dev/catapult/Catapult_utils/Ser/Arg_value/index.html index 4274c7d..57275f6 100644 --- a/dev/catapult/Catapult_utils/Ser/Arg_value/index.html +++ b/dev/catapult/Catapult_utils/Ser/Arg_value/index.html @@ -1,2 +1,2 @@ -Arg_value (catapult.Catapult_utils.Ser.Arg_value)

Module Ser.Arg_value

type t =
  1. | Int64 of int64
  2. | String of string
  3. | Bool of bool
  4. | Float64 of float
  5. | Void
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Arg_value (catapult.Catapult_utils.Ser.Arg_value)

Module Ser.Arg_value

type t =
  1. | Int64 of int64
  2. | String of string
  3. | Bool of bool
  4. | Float64 of float
  5. | Void
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html b/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html index af5105c..f7e0c3e 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html @@ -1,2 +1,2 @@ -Client_close_trace (catapult.Catapult_utils.Ser.Client_close_trace)

Module Ser.Client_close_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_close_trace (catapult.Catapult_utils.Ser.Client_close_trace)

Module Ser.Client_close_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_emit/index.html b/dev/catapult/Catapult_utils/Ser/Client_emit/index.html index 288846a..40ba1df 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_emit/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_emit/index.html @@ -1,2 +1,2 @@ -Client_emit (catapult.Catapult_utils.Ser.Client_emit)

Module Ser.Client_emit

type t = {
  1. trace_id : string;
  2. ev : Event.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_emit (catapult.Catapult_utils.Ser.Client_emit)

Module Ser.Client_emit

type t = {
  1. trace_id : string;
  2. ev : Event.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_message/index.html b/dev/catapult/Catapult_utils/Ser/Client_message/index.html index da50e29..f0fb4b3 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_message/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_message/index.html @@ -1,2 +1,2 @@ -Client_message (catapult.Catapult_utils.Ser.Client_message)

Module Ser.Client_message

type t =
  1. | Client_open_trace of Client_open_trace.t
  2. | Client_close_trace of Client_close_trace.t
  3. | Client_emit of Client_emit.t
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_message (catapult.Catapult_utils.Ser.Client_message)

Module Ser.Client_message

type t =
  1. | Client_open_trace of Client_open_trace.t
  2. | Client_close_trace of Client_close_trace.t
  3. | Client_emit of Client_emit.t
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html b/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html index a6f9c06..3d53dfb 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html @@ -1,2 +1,2 @@ -Client_open_trace (catapult.Catapult_utils.Ser.Client_open_trace)

Module Ser.Client_open_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_open_trace (catapult.Catapult_utils.Ser.Client_open_trace)

Module Ser.Client_open_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Event/index.html b/dev/catapult/Catapult_utils/Ser/Event/index.html index 0afa0c7..1fa7990 100644 --- a/dev/catapult/Catapult_utils/Ser/Event/index.html +++ b/dev/catapult/Catapult_utils/Ser/Event/index.html @@ -1,2 +1,2 @@ -Event (catapult.Catapult_utils.Ser.Event)

Module Ser.Event

type t = {
  1. id : string option;
  2. name : string;
  3. ph : int;
  4. pid : int64;
  5. tid : int64;
  6. cat : string array option;
  7. ts_us : float;
  8. args : Arg.t array option;
  9. stack : string array option;
  10. dur : float option;
  11. extra : Extra.t array option;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Event (catapult.Catapult_utils.Ser.Event)

Module Ser.Event

type t = {
  1. id : string option;
  2. name : string;
  3. ph : int;
  4. pid : int64;
  5. tid : int64;
  6. cat : string array option;
  7. ts_us : float;
  8. args : Arg.t array option;
  9. stack : string array option;
  10. dur : float option;
  11. extra : Extra.t array option;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Extra/index.html b/dev/catapult/Catapult_utils/Ser/Extra/index.html index cd4e091..485211d 100644 --- a/dev/catapult/Catapult_utils/Ser/Extra/index.html +++ b/dev/catapult/Catapult_utils/Ser/Extra/index.html @@ -1,2 +1,2 @@ -Extra (catapult.Catapult_utils.Ser.Extra)

Module Ser.Extra

type t = {
  1. key : string;
  2. value : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Extra (catapult.Catapult_utils.Ser.Extra)

Module Ser.Extra

type t = {
  1. key : string;
  2. value : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/index.html b/dev/catapult/Catapult_utils/Ser/index.html index 86c01b7..998e1f7 100644 --- a/dev/catapult/Catapult_utils/Ser/index.html +++ b/dev/catapult/Catapult_utils/Ser/index.html @@ -1,2 +1,2 @@ -Ser (catapult.Catapult_utils.Ser)

Module Catapult_utils.Ser

module Bare = Bare_encoding
module Arg_value : sig ... end
module Arg : sig ... end
module Extra : sig ... end
module Event : sig ... end
module Client_open_trace : sig ... end
module Client_close_trace : sig ... end
module Client_emit : sig ... end
module Client_message : sig ... end
\ No newline at end of file +Ser (catapult.Catapult_utils.Ser)

Module Catapult_utils.Ser

module Bare = Bare_encoding
module Arg_value : sig ... end
module Arg : sig ... end
module Extra : sig ... end
module Event : sig ... end
module Client_open_trace : sig ... end
module Client_close_trace : sig ... end
module Client_emit : sig ... end
module Client_message : sig ... end
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Thread_local/index.html b/dev/catapult/Catapult_utils/Thread_local/index.html index 3cdb6a2..693ced3 100644 --- a/dev/catapult/Catapult_utils/Thread_local/index.html +++ b/dev/catapult/Catapult_utils/Thread_local/index.html @@ -1,2 +1,2 @@ -Thread_local (catapult.Catapult_utils.Thread_local)

Module Catapult_utils.Thread_local

Basic thread-local storage.

Values are indexed by the thread ID, obtained (for example) via Thread.id (Thread.self()).

This module assumes that get_or_create m ~t_id is only ever called from the thread whose ID is t_id.

The close function may be called from another thread.

type 'a t
val create : init:(t_id:int -> 'a) -> close:('a -> unit) -> unit -> 'a t
val size : _ t -> int
val get_or_create : 'a t -> 'a
val remove : _ t -> t_id:int -> unit
val iter : f:('a -> unit) -> 'a t -> unit
val clear : _ t -> unit
\ No newline at end of file +Thread_local (catapult.Catapult_utils.Thread_local)

Module Catapult_utils.Thread_local

Basic thread-local storage.

Values are indexed by the thread ID, obtained (for example) via Thread.id (Thread.self()).

This module assumes that get_or_create m ~t_id is only ever called from the thread whose ID is t_id.

The close function may be called from another thread.

type 'a t
val create : init:(t_id:int -> 'a) -> close:('a -> unit) -> unit -> 'a t
val size : _ t -> int
val get_or_create : 'a t -> 'a
val remove : _ t -> t_id:int -> unit
val iter : f:('a -> unit) -> 'a t -> unit
val clear : _ t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/index.html b/dev/catapult/Catapult_utils/index.html index 06abf5b..7fc5565 100644 --- a/dev/catapult/Catapult_utils/index.html +++ b/dev/catapult/Catapult_utils/index.html @@ -1,2 +1,2 @@ -Catapult_utils (catapult.Catapult_utils)

Module Catapult_utils

module Bare_encoding : sig ... end

BARE runtime library.

module Endpoint_address : sig ... end

Address for the daemon

module Gc_stats : sig ... end
module Json_out : sig ... end

Basic output of json values to a buffer

module Ser : sig ... end
module Thread_local : sig ... end

Basic thread-local storage.

\ No newline at end of file +Catapult_utils (catapult.Catapult_utils)

Module Catapult_utils

module Bare_encoding : sig ... end

BARE runtime library.

module Endpoint_address : sig ... end

Address for the daemon

module Gc_stats : sig ... end
module Json_out : sig ... end

Basic output of json values to a buffer

module Ser : sig ... end
module Thread_local : sig ... end

Basic thread-local storage.

\ No newline at end of file diff --git a/dev/catapult/index.html b/dev/catapult/index.html index eaaf967..d5b24a3 100644 --- a/dev/catapult/index.html +++ b/dev/catapult/index.html @@ -1,2 +1,2 @@ -index (catapult.index)

catapult index

Library catapult

The entry point of this library is the module: Catapult.

Library catapult.utils

The entry point of this library is the module: Catapult_utils.

\ No newline at end of file +index (catapult.index)

catapult index

Library catapult

The entry point of this library is the module: Catapult.

Library catapult.utils

The entry point of this library is the module: Catapult_utils.

\ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 8c034fb..8e71f81 100644 --- a/dev/index.html +++ b/dev/index.html @@ -14,7 +14,6 @@

OCaml package documentation

  • catapult 0.2
  • catapult-client 0.2
  • catapult-daemon 0.2
    • -
  • catapult-file 0.2
  • catapult-sqlite 0.2