package mirage

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Code Serialization

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
    
    Tbl
  - 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

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.

module Set : sig ... end

Set implements sets over t elements.

Code Serialization

val call : t Fmt.t

call fmt k outputs name () to fmt, where n is k's 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