package builder
- Source
- package.scala
- Alphabetic
- By Inheritance
- builder
- Builder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type InfoMod[A] = Endo[types.ParserInfo[A]]
- Definition Classes
- Builder
- type PrefsMod = Endo[ParserPrefs]
- Definition Classes
- Builder
Value Members
- def abortOption[A](err: ParseError, mod: Mod[OptionFields, (A) => A]*): types.Parser[(A) => A]
An option that always fails.
An option that always fails.
- Definition Classes
- Builder
- def argument[A](p: ReadM[A], mod: Mod[ArgumentFields, A]*): types.Parser[A]
Builder for an argument parser.
Builder for an argument parser.
- Definition Classes
- Builder
- def bigDecimalArgument(mod: Mod[ArgumentFields, BigDecimal]*): types.Parser[BigDecimal]
Builder for a BigDecimal argument.
Builder for a BigDecimal argument.
- Definition Classes
- Builder
- def bigDecimalOption(mod: Mod[OptionFields, BigDecimal]*): types.Parser[BigDecimal]
Builder for an option taking a BigDecimal argument.
Builder for an option taking a BigDecimal argument.
- Definition Classes
- Builder
- def bigIntArgument(mod: Mod[ArgumentFields, BigInt]*): types.Parser[BigInt]
Builder for a BigInt argument.
Builder for a BigInt argument.
- Definition Classes
- Builder
- def bigIntOption(mod: Mod[OptionFields, BigInt]*): types.Parser[BigInt]
Builder for an option taking a BigInt argument.
Builder for an option taking a BigInt argument.
- Definition Classes
- Builder
- def byteArgument(mod: Mod[ArgumentFields, Byte]*): types.Parser[Byte]
Builder for a Byte argument.
Builder for a Byte argument.
- Definition Classes
- Builder
- def byteOption(mod: Mod[OptionFields, Byte]*): types.Parser[Byte]
Builder for an option taking a Byte argument.
Builder for an option taking a Byte argument.
- Definition Classes
- Builder
- def charArgument(mod: Mod[ArgumentFields, Char]*): types.Parser[Char]
Builder for a Char argument.
Builder for a Char argument.
- Definition Classes
- Builder
- def charOption(mod: Mod[OptionFields, Char]*): types.Parser[Char]
Builder for an option taking a Char argument.
Builder for an option taking a Char argument.
- Definition Classes
- Builder
- def columns(cols: Int): PrefsMod
- Definition Classes
- Builder
- def command[A](cmd: String, info: types.ParserInfo[A]): Mod[CommandFields, A]
Add a command to a subparser option.
Add a command to a subparser option.
- Definition Classes
- Builder
- def disabled[A]: ReadM[A]
Null Option reader.
Null Option reader. All arguments will fail validation.
- Definition Classes
- Builder
- val disambiguate: PrefsMod
- Definition Classes
- Builder
- def doubleArgument(mod: Mod[ArgumentFields, Double]*): types.Parser[Double]
Builder for a Double argument.
Builder for a Double argument.
- Definition Classes
- Builder
- def doubleOption(mod: Mod[OptionFields, Double]*): types.Parser[Double]
Builder for an option taking a Double argument.
Builder for an option taking a Double argument.
- Definition Classes
- Builder
- def eitherReader[A](f: (String) => \/[String, A]): ReadM[A]
Convert a function in the Either monad to a reader.
Convert a function in the Either monad to a reader.
- Definition Classes
- Builder
- def failureCode[A](code: Int): InfoMod[A]
- Definition Classes
- Builder
- def flag[A](defV: A, actV: A, mod: Mod[FlagFields, A]*): types.Parser[A]
Builder for a flag parser.
Builder for a flag parser.
- Definition Classes
- Builder
- def flag_[A](actV: A, mod: Mod[FlagFields, A]*): types.Parser[A]
Builder for a flag parser without a default value.
Builder for a flag parser without a default value.
- Definition Classes
- Builder
- def floatArgument(mod: Mod[ArgumentFields, Float]*): types.Parser[Float]
Builder for a Float argument.
Builder for a Float argument.
- Definition Classes
- Builder
- def floatOption(mod: Mod[OptionFields, Float]*): types.Parser[Float]
Builder for an option taking a Float argument.
Builder for an option taking a Float argument.
- Definition Classes
- Builder
- def footer[A](footer: String): InfoMod[A]
- Definition Classes
- Builder
- def footerDoc[A](doc: Option[Doc]): InfoMod[A]
- Definition Classes
- Builder
- def fromTryCatch[A](f: (String) => A): ReadM[A]
Turns an unsafe conversion function into a reader by catching non-fatal exceptions.
Turns an unsafe conversion function into a reader by catching non-fatal exceptions.
- Definition Classes
- Builder
- def header[A](header: String): InfoMod[A]
- Definition Classes
- Builder
- def headerDoc[A](doc: Option[Doc]): InfoMod[A]
- Definition Classes
- Builder
- def help[F[_], A](s: String): Mod[F, A]
Specify the help text for an option.
Specify the help text for an option.
- Definition Classes
- Builder
- def helpDoc[F[_], A](doc: Option[Doc]): Mod[F, A]
Specify the help Doc.
Specify the help Doc.
- Definition Classes
- Builder
- def hidden[F[_], A]: Mod[F, A]
Hide this option from the brief description.
Hide this option from the brief description.
- Definition Classes
- Builder
- def idm[M](implicit M: Monoid[M]): M
Trivial option modifier.
Trivial option modifier.
- Definition Classes
- Builder
- def info[A](parser: types.Parser[A], mod: InfoMod[A]*): types.ParserInfo[A]
- Definition Classes
- Builder
- def infoOption[A](s: String, mod: Mod[OptionFields, (A) => A]*): types.Parser[(A) => A]
An option that always fails and displays a message.
An option that always fails and displays a message.
- Definition Classes
- Builder
- def intArgument(mod: Mod[ArgumentFields, Int]*): types.Parser[Int]
Builder for a Int argument.
Builder for a Int argument.
- Definition Classes
- Builder
- def intOption(mod: Mod[OptionFields, Int]*): types.Parser[Int]
Builder for an option taking a Int argument.
Builder for an option taking a Int argument.
- Definition Classes
- Builder
- def long[F[_], A](s: String)(implicit F: HasName[F]): Mod[F, A]
Specify a long name for an option.
Specify a long name for an option.
- Definition Classes
- Builder
- def longArgument(mod: Mod[ArgumentFields, Long]*): types.Parser[Long]
Builder for a Long argument.
Builder for a Long argument.
- Definition Classes
- Builder
- def longOption(mod: Mod[OptionFields, Long]*): types.Parser[Long]
Builder for an option taking a Long argument.
Builder for an option taking a Long argument.
- Definition Classes
- Builder
- def metavar[F[_], A](v: String): Mod[F, A]
Specify a metavariable for the argument.
Specify a metavariable for the argument.
Metavariables have no effect on the parser, and only serve to specify the symbolic name for an argument to be displayed in the help text.
- Definition Classes
- Builder
- def multiSuffix(suffix: String): PrefsMod
- Definition Classes
- Builder
- def noArgError[A](e: ParseError): Mod[OptionFields, A]
Specify the error to display when no argument is provided to this option.
Specify the error to display when no argument is provided to this option.
- Definition Classes
- Builder
- val noBacktrack: PrefsMod
- Definition Classes
- Builder
- def noIntersperse[A]: InfoMod[A]
- Definition Classes
- Builder
- def option[A](r: ReadM[A], mod: Mod[OptionFields, A]*): types.Parser[A]
- Definition Classes
- Builder
- def prefs(mod: PrefsMod*): ParserPrefs
- Definition Classes
- Builder
- def progDesc[A](desc: String): InfoMod[A]
Specify a short program description.
Specify a short program description.
- Definition Classes
- Builder
- def progDescDoc[A](doc: Option[Doc]): InfoMod[A]
- Definition Classes
- Builder
- val readBigDecimal: ReadM[BigDecimal]
BigDecimal reader
BigDecimal reader
- Definition Classes
- Builder
- val readBigInt: ReadM[BigInt]
BigInt reader
BigInt reader
- Definition Classes
- Builder
- val readByte: ReadM[Byte]
Byte reader
Byte reader
- Definition Classes
- Builder
- val readChar: ReadM[Char]
Char reader
Char reader
- Definition Classes
- Builder
- val readDouble: ReadM[Double]
Double reader
Double reader
- Definition Classes
- Builder
- val readFloat: ReadM[Float]
Float reader
Float reader
- Definition Classes
- Builder
- val readInt: ReadM[Int]
Int reader.
Int reader.
- Definition Classes
- Builder
- val readLong: ReadM[Long]
Long reader
Long reader
- Definition Classes
- Builder
- val readShort: ReadM[Short]
Short reader
Short reader
- Definition Classes
- Builder
- val readStr: ReadM[String]
String reader.
String reader.
- Definition Classes
- Builder
- def short[F[_], A](c: Char)(implicit F: HasName[F]): Mod[F, A]
Specify a short name for an option.
Specify a short name for an option.
- Definition Classes
- Builder
- def shortArgument(mod: Mod[ArgumentFields, Short]*): types.Parser[Short]
Builder for a Short argument.
Builder for a Short argument.
- Definition Classes
- Builder
- def shortOption(mod: Mod[OptionFields, Short]*): types.Parser[Short]
Builder for an option taking a Short argument.
Builder for an option taking a Short argument.
- Definition Classes
- Builder
- def showDefault[F[_], A](implicit A: Show[A]): Mod[F, A]
Show the default value for this option using its Show instance.
Show the default value for this option using its Show instance.
- Definition Classes
- Builder
- def showDefaultWith[F[_], A](f: (A) => String): Mod[F, A]
Specify a function to show the default value for an option.
Specify a function to show the default value for an option.
- Definition Classes
- Builder
- val showHelpOnError: PrefsMod
- Definition Classes
- Builder
- def strArgument(mod: Mod[ArgumentFields, String]*): types.Parser[String]
Builder for a String argument.
Builder for a String argument.
- Definition Classes
- Builder
- def strOption(mod: Mod[OptionFields, String]*): types.Parser[String]
Builder for an option taking a String argument.
Builder for an option taking a String argument.
- Definition Classes
- Builder
- def subparser[A](mod: Mod[CommandFields, A]*): types.Parser[A]
Builder for a command parser.
Builder for a command parser. The command modifier can be used to specify individual commands.
- Definition Classes
- Builder
- def switch(mod: Mod[FlagFields, Boolean]*): types.Parser[Boolean]
Builder for a boolean flag.
Builder for a boolean flag.
- Definition Classes
- Builder
- def value[F[_], A](a: A): Mod[F, A]
Specify a default value for an option.
Specify a default value for an option.
- Definition Classes
- Builder