Vexil (Vexil v0.1.0) View Source
Documentation for Vexil
.
Link to this section Summary
Link to this section Types
Specs
argv() :: Vexil.Utils.argv()
Specs
Specs
find_flags_result() :: {:ok, parsed_flags(), [find_flags_error()], argv()} | find_flags_error()
Specs
Specs
find_options_result() :: {:ok, parsed_options(), [find_options_error()], argv()} | find_options_error()
Specs
flags() :: [{atom(), Vexil.Structs.Flags.t()}]
Specs
Specs
options() :: [{atom(), Vexil.Structs.Options.t()}]
Specs
parse_result() :: {:ok, parsed_items(), {[find_options_error()], [find_flags_error()]}} | validate_opts_error() | validate_argv_error() | find_options_error() | find_flags_error()
Specs
parse_spec() :: [parse_spec_item()]
Specs
Specs
parsed_flags() :: %{required(atom()) => pos_integer() | boolean()}
Specs
parsed_items() :: %{ flags: parsed_flags(), options: parsed_options(), argv: argv() }
Specs
Specs
validate_argv_error() :: {:error, :invalid_argv}
Specs
Link to this section Functions
Specs
parse(argv(), parse_spec()) :: parse_result()
Specs
parse!(argv(), parse_spec()) :: any()