package octez-l2-libs

You can search for identifiers within the package.

in-package search v0.2.0

Package contains no libraries

This module implements a FIFO queue to model the input. The messages are queued in an input_buffer in their order of appearance in the inbox.

type message = {

raw_level : int32;
message_counter : Z.t;
payload : bytes;

}

val pp_message : 
  Ppx_deriving_runtime.Format.formatter ->
  message ->
  Ppx_deriving_runtime.unit

val show_message : message -> Ppx_deriving_runtime.string

An element of type t will have a content which is a lazy_vector of messages and a pointer to the number of elements to be able to dequeue. At this point there is no cleanup operation so an input_buffer content will likely have more than num_elements messages (see #3340).

type t = message Tezos_lazy_containers.Lazy_vector.Mutable.ZVector.t

exception Bounds

exception SizeOverflow

exception Cannot_store_an_earlier_message

exception Dequeue_from_empty_queue

val alloc : unit -> t

alloc () returns an empty input_buffer.

val num_elements : t -> Z.t

num_elements buffer is the number of elements of buffer. It is used by dequeue to pick the current message. Note that it is not necessarily equal to the length of the content of the inbox (see #3340).

val reset : t -> unit

reset buffer removes the current contents of the buffer.

val dequeue : t -> message Lwt.t

dequeue buffer pops the current message from buffer and returns it. Note that the input buffer models a FIFO queue so the current message is the oldest in the queue. If the queue is empty it raises Dequeue_from_empty_queue.

val enqueue : t -> message -> unit Lwt.t

enqueue buffer message pushes the given message into the buffer. Note that the message will have to have a higher raw_level/message_counter than than the newest message in the queue. If that fails it will raise the error Cannot_store_an_earlier_message.

val snapshot : t -> t

snapshot buffer returns snapshotted buffer. You can modify original one, snapshotted one will stay untouched