View Source Comtile38.Command.Argument (Comtile38 v0.0.2)

Link to this section Summary

Functions

The Argument struct.

Function to split the arguments that are optional or commands from the required ones.

Link to this section Functions

Link to this function

%Comtile38.Command.Argument{}

View Source (struct)

The Argument struct.

It will encompass all data read from the command file for each argument.

  • :name - name of the argument as read from the file
  • :canonical_name - string representation of the name
  • :type - type of the argument
  • :optional - boolean value indicating if the argument is optional
  • :multiple - boolean value indicating if the argument can be used multiple times
  • :enum - possible values if the argument is enumerable
  • :variadic -
  • :command - command that must preceed the argument
Link to this function

split_options(arguments)

View Source

Function to split the arguments that are optional or commands from the required ones.

It will receive a list of Comtile38.Command.Argument structs and return a tuple with the required arguments first and then the others.