package b0

You can search for identifiers within the package.

in-package search v0.2.0

Software construction and deployment kit

Install

Dune Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (1)

Authors

T

The b0 programmers

Maintainers

Daniel Bünzli

Sources

b0-0.0.5.tbz

sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e

doc/b0.b00/B000/Guard/index.html

Module `B000.Guard`

Build operation guards.

A guard ensure that a build operation is allowed to proceed. This means either that:

It is ready and can be submitted for execution. This happens once all the files the operation reads are ready: they exist and are up-to-date.
It is aborted. This happens if a file it needs to read never becomes ready.

Note. This module does not access the file system it trusts clients that call Guard.set_file_ready not to lie about its existence on the file system.

Guards

type t

The type for build operations guards.

val create : unit -> t

create () is a new guard.

val set_file_ready : t -> B0_std.Fpath.t -> unit

set_file_ready g f indicates to g that file f is ready, i.e. that it exists and is up-to-date.

val set_file_never : t -> B0_std.Fpath.t -> unit

set_file_never g f indicate to g that file f will never become ready.

val add : t -> Op.t -> unit

add g o guards o in g until it is allowed.

val allowed : t -> Op.t option

allowed g is an operation that is either ready or aborted in g (if any). In the second case the Op.status is Op.status.Aborted.

On This Page

Guards