package cmdlang-stdlib-runner

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Initialization
Parsing
Finalization

cmdlang-stdlib-runner
- Cmdlang_stdlib_runner

Legend:
Library
Module
Module type
Parameter
Class
Class type

A mutable state that will collect parsing information.

The strategy implemented by the cmdlang runner is to create such parser state, enrich it during a parsing phases using stdlib.arg, and once this is done, return an expression suitable for evaluation.

type 'a t

Initialization

In this part we allocate a parser state for a given parser. Once this is done, the parser must be enriched with information coming from the command line.

val create : 'a Cmdlang_ast.Ast.Arg.t -> 'a t Cmdlang_ast.Ast.or_error_msg

Parsing

This part is what allows stdlib.arg to performs the expected side-effects within the state.

val spec : _ t -> (Stdlib.Arg.key * Stdlib.Arg.spec * Stdlib.Arg.doc) list

val positional_state : _ t -> Cmdlang_stdlib_runner__.Positional_state.t

Finalization

Once the parsing has been done, we can finalize the state and return an evaluation suitable for execution.

val finalize : 
  'a t ->
  ('a Cmdlang_stdlib_runner__.Arg_runner.t, Arg_state.Parse_error.t)
    Stdlib.Result.t