package mirage

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Triggering Hooks

package mirage

mirage
- Mirage
  - Key
  - Project
  - Runtime_arg
  - Tool
mirage.devices
- Devices
  - Argv
  - Arp
  - Block
  - Conduit
  - Dns
  - Ethernet
  - Git
  - Happy_eyeballs
  - Http
  - Icmp
  - Ip
  - Key
  - Kv
  - Libvirt
  - Mclock
  - Mimic
  - Misc
  - Network
  - Pclock
  - Qubesdb
  - Random
  - Reporter
  - Resolver
  - Runtime_arg
    
    V4
    
    V6
  - Stack
  - Syslog
  - Target
    
    Solo5
    
    TARGET
    
    Unix
    
    Xen
    
    Substitutions
  - Tcp
  - Time
  - Udp
mirage.functoria
- Functoria
  - Action
    
    Infix
    
    List
    
    Syntax
  - Cli
  - Context
  - DSL
  - Device
    
    Graph
  - Dune
  - Engine
  - Impl
  - Info
  - Install
  - Key
    
    Arg
    
    Set
  - Lib
    
    Make
    
    _
    
    S
  - Opam
  - Package
    
    Set
  - Runtime_arg
    
    Set
  - Tool
    
    Make
    
    _
    
    S
  - Type

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functoria engine.

val if_keys : Impl.abstract -> Key.Set.t

if_keys t is the set of if keys in the graph t.

val keys : Impl.abstract -> Key.Set.t

keys t is the set of keys in the graph t.

val runtime_args : Impl.abstract -> Runtime_arg.Set.t

runtime_args t is the set of runtime arguments in the graph t.

val packages : Impl.abstract -> Package.t list Key.value

packages t is the set of packages in the graph t.

val install : Info.t -> Impl.abstract -> Install.t Key.value

install i t is the set of files installed by the graph t.

val files : Info.t -> Impl.abstract -> Fpath.Set.t

files i t is the list of files generated configure-time.

val dune : Info.t -> Impl.abstract -> Dune.stanza list

dune i t is the list of dune stanzas needed to build the project t with the build information i.

Triggering Hooks

type t = Device.Graph.t

The type for key graphs.

val configure : Info.t -> t -> unit Action.t

configure i t calls all the configuration hooks for each of the implementations appearing in t, in topological order. Use the build information i.

val connect : ?init:'a Impl.t list -> Info.t -> t -> unit Action.t

connect ?init i t generates the connect functions in main.ml, for each of the implementations appearing t, in topological order. Use build information i.