package mirage
-
mirage
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mirage
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Signature for configurable module implementations. A configurable is a module implementation which contains a runtime state which can be set either at configuration time (by the application builder) or at runtime, using command-line arguments.
method ty : 'ty typty is the module type of the configurable.
packages is the list of OPAM packages which needs to be installed before compiling the configurable.
method connect : Info.t -> string -> string list -> stringconnect info mod args is the code to execute in order to initialize the state associated with the module mod (usually calling mod.connect) with the arguments args, in the context of the project information info.
method configure : Info.t -> (unit, Rresult.R.msg) Stdlib.resultconfigure info is the code to execute in order to configure the device. During the configuration phase, the specficied packages might not yet be there. The code might involve generating more OCaml code, running shell scripts, etc.
method build : Info.t -> (unit, Rresult.R.msg) Stdlib.resultbuild info is the code to execute in order to build the device. During the build phase, you can rely that all packages are installed (via opam). The code might involve generating more OCaml code (crunching directories), running shell scripts, etc.
method clean : Info.t -> (unit, Rresult.R.msg) Stdlib.resultclean info is the code to clean-up what has been generated by build and configure.
method keys : key listkeys is the list of command-line keys to set-up the configurable.
method deps : abstract_impl listdeps is the list of abstract implementations that must be initialized before calling connect.