Conv (cmdliner.Cmdliner.Arg.Conv)

Converters

type 'a parser = string -> ('a, string) result

The type for parsing arguments to values of type 'a.

type 'a fmt = Stdlib.Format.formatter -> 'a -> unit

The type for formatting values of type 'a.

type 'a t

The type for converting arguments to values of type 'a.

val make : 
  ?completion:'a Completion.t ->
  docv:string ->
  parser:'a parser ->
  pp:'a fmt ->
  unit ->
  'a t

make ~docv ~parser ~pp () is an argument converter with given properties. See corresponding accessors for semantics.

val of_conv : 
  ?completion:'a Completion.t ->
  ?docv:string ->
  ?parser:'a parser ->
  ?pp:'a fmt ->
  'a t ->
  'a t

of_conv conv () is a new converter with given unspecified properties defaulting to those of conv.

Properties

val docv : 'a t -> string

docv c is c's documentation meta-variable. This value can be refered to as $(docv) in the documentation strings of arguments. It can be overriden by the info value of an argument.

val parser : 'a t -> 'a parser

parser c is c's argument parser.

val pp : 'a t -> 'a fmt

pp c is c's argument formatter.

val completion : 'a t -> 'a Completion.t

completion c is c's completion.