package octez-internal-libs

  1. Overview
  2. Docs
A package that contains some libraries used by the Octez suite

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/irmin_pack_unix/Irmin_pack_unix/Async/Unix/index.html

Module Async.UnixSource

Basic abstraction for a worker.

Sourcetype t

A task

Sourcetype outcome = [
  1. | `Success
  2. | `Cancelled
  3. | `Failure of string
]
Sourceval outcome_t : outcome Irmin.Type.t
Sourcetype status = [
  1. | outcome
  2. | `Running
]
Sourceval status_t : status Irmin.Type.t
Sourceval async : (unit -> unit) -> t

Start a task.

Sourceval await : t -> [> outcome ] Lwt.t

If running, wait for a task to finish and return its outcome.

If not running, return the oucome of the task.

Sourceval status : t -> [> status ]

If running, refresh the status of the task, without blocking.

If not running, return the oucome of the task.

Sourceval cancel : t -> bool

If running, cancel the task and return true.

If not running, do nothing and return false.

OCaml

Innovation. Community. Security.