scopt/scopt/OParserBuilder

OParserBuilder

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

Value members

Concrete methods

def arg[A : Read](name: String): OParser[A, C]

adds an argument invoked by an option without - or --.

adds an argument invoked by an option without - or --.

Value parameters:
name

name in the usage text

def checkConfig(f: C => Either[String, Unit]): OParser[Unit, C]

adds final check.

adds final check.

def cmd(name: String): OParser[Unit, C]

adds a command invoked by an option without - or --.

adds a command invoked by an option without - or --.

Value parameters:
name

name of the command

def failure(msg: String): Either[String, Unit]

call this to express failure in custom validation.

call this to express failure in custom validation.

def head(xs: String*): OParser[Unit, C]

adds usage text.

adds usage text.

def help(name: String): OParser[Unit, C]

adds an option invoked by --name that displays usage text and exits.

adds an option invoked by --name that displays usage text and exits.

Value parameters:
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.

adds an option invoked by -x or --name that displays usage text and exits.

Value parameters:
name

name of the option

x

name of the short option

protected def makeDef[A : Read](kind: OptionDefKind, name: String): OptionDef[A, C]
def note(x: String): OParser[Unit, C]

adds usage text.

adds usage text.

def opt[A : Read](name: String): OParser[A, C]

adds an option invoked by --name x.

adds an option invoked by --name x.

Value parameters:
name

name of the option

def opt[A : Read](x: Char, name: String): OParser[A, C]

adds an option invoked by -x value or --name value.

adds an option invoked by -x value or --name value.

Value parameters:
name

name of the option

x

name of the short option

def programName(x: String): OParser[Unit, C]
def success: Either[String, Unit]

call this to express success in custom validation.

call this to express success in custom validation.

def version(name: String): OParser[Unit, C]

adds an option invoked by --name that displays header text and exits.

adds an option invoked by --name that displays header text and exits.

Value parameters:
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.

adds an option invoked by -x or --name that displays header text and exits.

Value parameters:
name

name of the option

x

name of the short option

protected def wrap[A](d: OptionDef[A, C]): OParser[A, C]