Merge PR #12092: Implement a name-based representation for vo files.

Reviewed-by: ejgallego
Ack-by: gares

1 files changed, 37 insertions, 0 deletions

diff --git a/lib/objFile.mli b/lib/objFile.mli
new file mode 100644
index 0000000000..b15b04ee54
--- /dev/null
+++ b/lib/objFile.mli
@@ -0,0 +1,37 @@
+(************************************************************************)
+(*         *   The Coq Proof Assistant / The Coq Development Team       *)
+(*  v      *         Copyright INRIA, CNRS and contributors             *)
+(* <O___,, * (see version control and CREDITS file for authors & dates) *)
+(*   \VV/  **************************************************************)
+(*    //   *    This file is distributed under the terms of the         *)
+(*         *     GNU Lesser General Public License Version 2.1          *)
+(*         *     (see LICENSE file for the text of the license)         *)
+(************************************************************************)
+
+val magic_number : int32
+
+type segment = {
+  name : string;
+  pos : int64;
+  len : int64;
+  hash : Digest.t;
+}
+
+type in_handle
+type out_handle
+
+val open_in : file:string -> in_handle
+val close_in : in_handle -> unit
+val marshal_in_segment : in_handle -> segment:string -> 'a * Digest.t
+val get_segment : in_handle -> segment:string -> segment
+val segments : in_handle -> segment CString.Map.t
+
+val open_out : file:string -> out_handle
+val close_out : out_handle -> unit
+val marshal_out_segment : out_handle -> segment:string -> 'a -> unit
+val marshal_out_binary : out_handle -> segment:string -> out_channel * (unit -> unit)
+(** [marshal_out_binary oh segment] is a low level, stateful, API returning
+    [oc, stop]. Once called no other API can be used on the same [oh] and only
+    [Stdlib.output_*] APIs should be used on [oc]. [stop ()] must be invoked in
+    order to signal that all data was written to [oc] (which should not be used
+    afterwards). Only after calling [stop] the other API can be used on [oh]. *)