harness-cli/harness.cli/Parser

Parser

object Parser
Companion:
class
class Object
trait Matchable
class Any
Parser.type

Type members

Classlikes

final case class BuildResult[+T](usedParams: Set[Name], helpMessage: HelpMessage, helpExtraMessage: HelpMessage, parse: IndexedArgs => ParseResult[T])
object ParseResult
Companion:
class
sealed trait ParseResult[+T]
Companion:
object
object toggle

Parses a boolean based on prefix of baseName:

Parses a boolean based on prefix of baseName:

  • --[dont-]run : --dont-run [false] / --run [true]
  • --[do/dont]-run : --do-run [true] / --dont-run [false]
object value

Parses a value from a param:

Parses a value from a param:

  • --base-name VALUE
  • --base-name=VALUE
object values

Parses many values from a param:

Parses many values from a param:

  • --base-name VALUE --base-name VALUE
  • --base-name=VALUE

Value members

Concrete methods

def const[T](value: => T): Parser[T]
def firstOf[T](parser0: Parser[T], parser1: Parser[T], parserN: Parser[T]*): Parser[T]
def flag(baseName: LongName, ifPresent: => Boolean, shortParam: Optional[ShortName], helpHint: List[String], helpExtraHint: List[String]): Parser[Boolean]

Parses a boolean based on whether baseName is provided:

Parses a boolean based on whether baseName is provided:

  • --base-name [ifPresent] / no param [!ifPresent]
def helpMessage(left: List[String], right: List[String], rightExtra: List[String]): Parser[Unit]
def present[T](baseName: LongName, ifPresent: => T, shortParam: Optional[ShortName], helpHint: List[String], helpExtraHint: List[String]): Parser[T]

If present, returns ifPresent, otherwise, fails.

If present, returns ifPresent, otherwise, fails.

def rawValue[T](baseName: LongName, helpHint: List[String], helpExtraHint: List[String])(implicit decoder: StringDecoder[T]): Parser[T]

Parses a single normal value, without a param.
Note that this should be used AFTER all param-based calls, because otherwise, something like:
--key KEY-VALUE VALUE
would pull out the KEY-VALUE, and then parse --key VALUE

Parses a single normal value, without a param.
Note that this should be used AFTER all param-based calls, because otherwise, something like:
--key KEY-VALUE VALUE
would pull out the KEY-VALUE, and then parse --key VALUE

def rawValues[T](baseName: LongName, helpHint: List[String], helpExtraHint: List[String])(implicit decoder: StringDecoder[T]): Parser[List[T]]

Parses all normal values, without a param.
Note that this should be used AFTER all param-based calls, because otherwise, something like:
--key KEY-VALUE VALUE
would pull out the KEY-VALUE and VALUE, and then parse --key

Parses all normal values, without a param.
Note that this should be used AFTER all param-based calls, because otherwise, something like:
--key KEY-VALUE VALUE
would pull out the KEY-VALUE and VALUE, and then parse --key

Concrete fields

val help: Parser[Boolean]

true : help-extra false : help

true : help-extra false : help

val unit: Parser[Unit]