irmin-lwt: declare Closeable trait and use it in S.Repo

balat · balat · commit 9e9fa6dd5aa4 · 2026-04-28T10:28:03.000+02:00
Mirror Irmin 3.11's [Repo] signature, which exposes its [val close]
through [include Closeable with type _ t := t] rather than as a free
[val close]. The visible signature is unchanged for clients reading
fields directly, but [module M : Irmin_lwt.Closeable = ...]-style
constraints now type-check against [Repo].
diff --git a/src/irmin-lwt/irmin_lwt.ml b/src/irmin-lwt/irmin_lwt.ml
@@ -15,6 +15,12 @@ let run_with_env env f =
   Lwt_eio.with_event_loop ~clock:env#clock @@ fun _ ->
   Lwt_eio.Promise.await_lwt (f ())
 
+module type Closeable = sig
+  type 'a t
+
+  val close : 'a t -> unit Lwt.t
+end
+
 module type S = sig
   (** {1 Schema} *)
 
@@ -99,7 +105,9 @@ module type S = sig
 
     val elt_t : elt Irmin.Type.t
     val v : Irmin.Backend.Conf.t -> t Lwt.t
-    val close : t -> unit Lwt.t
+
+    include Closeable with type _ t := t
+
     val heads : t -> commit list Lwt.t
     val branches : t -> branch list Lwt.t
     val config : t -> Irmin.Backend.Conf.t
diff --git a/src/irmin-lwt/irmin_lwt.mli b/src/irmin-lwt/irmin_lwt.mli
@@ -19,6 +19,16 @@ val run_with_env : < clock : _ Eio.Time.clock ; .. > -> (unit -> 'a Lwt.t) -> 'a
     instead of calling [Eio_main.run] internally. Useful when the client is
     already inside an Eio event loop. *)
 
+(** Lwt-flavoured counterpart of the internal [Irmin.Closeable] trait: a single
+    [close] operation that releases the resources held by a handle. Used as
+    [include Closeable with type _ t := t] in [S.Repo] to mirror the Irmin 3
+    [Repo] signature. *)
+module type Closeable = sig
+  type 'a t
+
+  val close : 'a t -> unit Lwt.t
+end
+
 (** The Lwt-flavoured counterpart of [Irmin.Generic_key.S].
 
     Every I/O-triggering operation of [Irmin.Generic_key.S] is replaced by a
@@ -113,7 +123,10 @@ module type S = sig
 
     val elt_t : elt Irmin.Type.t
     val v : Irmin.Backend.Conf.t -> t Lwt.t
-    val close : t -> unit Lwt.t
+
+    include Closeable with type _ t := t
+    (** @inline *)
+
     val heads : t -> commit list Lwt.t
     val branches : t -> branch list Lwt.t
     val config : t -> Irmin.Backend.Conf.t
