Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mirage
Mirage command-line arguments
include module type of Functoria_runtime.Arg
Arg defines command-line arguments which can be set at runtime. This module is the runtime companion of Functoria_key. It exposes a subset of Cmdliner.Arg.
Runtime command-line arguments
The type for runtime command-line arguments. Similar to Functoria_key.Arg.t but only available at runtime.
val opt : 'a Cmdliner.Arg.converter -> 'a -> Cmdliner.Arg.info -> 'a topt is the runtime companion of Functoria_key.Arg.opt.
val required : 'a Cmdliner.Arg.converter -> Cmdliner.Arg.info -> 'a trequired is the runtime companion of Functoria_key.Arg.required.
val key : ?default:'a -> 'a Cmdliner.Arg.converter -> Cmdliner.Arg.info -> 'a tkey is either opt or runtime, depending if ~default is provided.
val flag : Cmdliner.Arg.info -> bool tflag is the runtime companion of Functoria_key.Arg.flag.
val make : (string -> 'a option) -> 'a Fmt.t -> 'a Cmdliner.Arg.convertermake of_string pp is the command-line argument converter using on of_string and pp.
module type S = sig ... endS is the signature used by of_module to create a command-line argument converter.
val of_module : (module S with type t = 'a) -> 'a Cmdliner.Arg.converterof module (module M) creates a command-line argyument converter from a module satisfying the signature S.
Mirage command-line argument converters
val ip : Ipaddr.t Cmdliner.Arg.converterip converts IP address.
val ipv4 : Ipaddr.V4.t Cmdliner.Arg.converteripv4 converts IPv4 address.
val ipv6 : Ipaddr.V6.t Cmdliner.Arg.converteripv6converts IPv6 address.
val ipv6_prefix : Ipaddr.V6.Prefix.t Cmdliner.Arg.converteripv6_prefix converts IPv6 prefixes.
val log_threshold : log_threshold Cmdliner.Arg.converterlog_threshold converts log reporter threshold.