scanAndParseArgs<O extends OptionDefinition> function

ArgParseResult<O> scanAndParseArgs<O extends OptionDefinition>(
  1. Iterable<String> args, {
  2. required Iterable<O> options,
  3. ScanMode scanMode = const ScanMode(),
})

Scans the arguments and parses them into an ArgParseResult corresponding to a single set of options.

Does not handle subcommands. Usage problems are recorded on ArgParseResult.errors and parsing continues. Invalid option definitions still throw.

Implementation

ArgParseResult<O> scanAndParseArgs<O extends OptionDefinition>(
  final Iterable<String> args, {
  required final Iterable<O> options,
  final ScanMode scanMode = const ScanMode(),
}) {
  validateOptions(options);

  final scannedArgs = scanArgs(args);

  return _parseArgs(
    _ArgCursor(scannedArgs),
    options: options,
    scanMode: scanMode,
  );
}