clikt / com.github.ajalt.clikt.parsers / OptionParser

OptionParser

interface OptionParser

A parser for Options.

All functions should be pure, since the same command instance can parse arguments multiple times.

Types

Invocation

data class Invocation

The input from a single instance of an option input.

ParseResult

data class ParseResult

Functions

parseLongOpt

abstract fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult

Parse a single long option and its value.

parseShortOpt

abstract fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

Parse a single short option and its value.

Inheritors

FlagOptionParser

object FlagOptionParser : OptionParser

A parser for options that take no values.

OptionWithValuesParser

object OptionWithValuesParser : OptionParser

An option that takes one more values