scopt/scopt/OParserBuilder

OParserBuilder

abstract class OParserBuilder[C]
class Object
trait Matchable
class Any

Value members

Methods

def programName(x: String): OParser[Unit, C]
def opt[A](name: String)(evidence$1: Read[A]): OParser[A, C]
adds an option invoked by --name x.
Value Params
name
name of the option
def opt[A](x: Char, name: String)(evidence$2: Read[A]): OParser[A, C]
adds an option invoked by -x value or --name value.
Value Params
name
name of the option
x
name of the short option
def note(x: String): OParser[Unit, C]
adds usage text.
def arg[A](name: String)(evidence$3: Read[A]): OParser[A, C]
adds an argument invoked by an option without - or --.
Value Params
name
name in the usage text
def cmd(name: String): OParser[Unit, C]
adds a command invoked by an option without - or --.
Value Params
name
name of the command
def checkConfig(f: C => Either[String, Unit]): OParser[Unit, C]
adds final check.
def version(name: String): OParser[Unit, C]
adds an option invoked by --name that displays header text and exits.
Value Params
name
name of the option
def version(x: Char, name: String): OParser[Unit, C]
adds an option invoked by -x or --name that displays header text and exits.
Value Params
name
name of the option
x
name of the short option
def help(name: String): OParser[Unit, C]
adds an option invoked by --name that displays usage text and exits.
Value Params
name
name of the option
def help(x: Char, name: String): OParser[Unit, C]
adds an option invoked by -x or --name that displays usage text and exits.
Value Params
name
name of the option
x
name of the short option
def success: Either[String, Unit]
call this to express success in custom validation.
def failure(msg: String): Either[String, Unit]
call this to express failure in custom validation.
protected def wrap[A](d: OptionDef[A, C]): OParser[A, C]
protected def makeDef[A](kind: OptionDefKind, name: String)(evidence$4: Read[A]): OptionDef[A, C]