unikernel/duniverse/mirage/lib/functoria/runtime_arg.mli

@@ -0,0 +1,55 @@
+(*
+ * Copyright (c) 2023 Thomas Gazagnaire <thomas@gazagnaire.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *)
+
+(** Define runtime command-line arguments. *)
+
+type 'a arg
+(** The type for command-line arguments that reads a value of type ['a]. *)
+
+val create :
+  pos:string * int * int * int -> ?packages:Package.t list -> string -> 'a arg
+(** [create ~pos ?packages v] is the runtime argument pointing to the value [v].
+    [pos] is expected to be [__POS__]. [packages] specifies in which opam
+    package the value [v] is defined. This should be constrained to the correct
+    type of the variable it is pointing to. *)
+
+type t
+(** The type command-line arguments where the type of the value is abstract. *)
+
+val packages : t -> Package.t list
+
+val v : 'a arg -> t
+(** [v k] is the [k] with its type hidden. *)
+
+(** [Set] implements sets over [t] elements. *)
+module Set : sig
+  include Set.S with type elt = t
+
+  val pp : t Fmt.t
+  (** [pp] pretty-prints sets of keys. *)
+end
+
+(** {1 Code Serialization} *)
+
+val call : t Fmt.t
+(** [call fmt k] outputs [name ()] to [fmt], where [n] is [k]'s
+    {{!ocaml_name} OCaml name}. *)
+
+val serialize : runtime_modname:string -> t Fmt.t
+(** [serialize ctx ppf k] outputs the [Cmdliner] runes to parse command-line
+    arguments represented by [k] at runtime. *)
+
+val var_name : t -> string