package mirage

  1. Overview
  2. Docs
The MirageOS library operating system

Install

dune-project
 Dependency

Authors

Maintainers

Sources

mirage-4.10.3.tbz
sha256=648db61b37ba27281a16d4917ef963f36d84c22d9f0596ca1955e871bdce8133
sha512=74da93861e0d915564db77dee56aa207a53bc35f75087dd78c9fcd8f24fbdea68c04404b901b90ba62c8b577be9fda0b8980322c6e8a2f423c6c6f6b96779f45

doc/mirage.functoria/Functoria/Runtime_arg/index.html

Module Functoria.Runtime_argSource

Define runtime command-line arguments.

Sourcetype 'a arg

The type for command-line arguments that reads a value of type 'a.

Sourceval 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.

Sourcetype t

The type command-line arguments where the type of the value is abstract.

Sourceval packages : t -> Package.t list
Sourceval v : 'a arg -> t

v k is the k with its type hidden.

Sourcemodule Set : sig ... end

Set implements sets over t elements.

Code Serialization

Sourceval call : t Fmt.t

call fmt k outputs name () to fmt, where n is k's OCaml name.

Sourceval 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.

Sourceval var_name : t -> string