Packages

p

optparse_applicative

package optparse_applicative

Source
package.scala
Linear Supertypes
ParserFunctions, Help, Extra, Common, Builder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. optparse_applicative
  2. ParserFunctions
  3. Help
  4. Extra
  5. Common
  6. Builder
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait ArgsState[F[_]] extends AnyRef
    Definition Classes
    Common
  2. type InfoMod[A] = Endo[optparse_applicative.types.ParserInfo[A]]
    Definition Classes
    Builder
  3. type Parser[A] = optparse_applicative.types.Parser[A]
  4. type ParserInfo[A] = optparse_applicative.types.ParserInfo[A]
  5. type PrefsMod = Endo[ParserPrefs]
    Definition Classes
    Builder

Value Members

  1. def abortOption[A](err: ParseError, mod: Mod[OptionFields, (A) ⇒ A]*): optparse_applicative.types.Parser[(A) ⇒ A]

    An option that always fails.

    An option that always fails.

    Definition Classes
    Builder
  2. def argMatches[F[_], A](opt: OptReader[A], arg: String)(implicit F: MonadP[F]): Option[StateT[F, Args, A]]
    Definition Classes
    Common
  3. def argument[A](p: ReadM[A], mod: Mod[ArgumentFields, A]*): optparse_applicative.types.Parser[A]

    Builder for an argument parser.

    Builder for an argument parser.

    Definition Classes
    Builder
  4. def bigDecimalArgument(mod: Mod[ArgumentFields, BigDecimal]*): optparse_applicative.types.Parser[BigDecimal]

    Builder for a BigDecimal argument.

    Builder for a BigDecimal argument.

    Definition Classes
    Builder
  5. def bigDecimalOption(mod: Mod[OptionFields, BigDecimal]*): optparse_applicative.types.Parser[BigDecimal]

    Builder for an option taking a BigDecimal argument.

    Builder for an option taking a BigDecimal argument.

    Definition Classes
    Builder
  6. def bigIntArgument(mod: Mod[ArgumentFields, BigInt]*): optparse_applicative.types.Parser[BigInt]

    Builder for a BigInt argument.

    Builder for a BigInt argument.

    Definition Classes
    Builder
  7. def bigIntOption(mod: Mod[OptionFields, BigInt]*): optparse_applicative.types.Parser[BigInt]

    Builder for an option taking a BigInt argument.

    Builder for an option taking a BigInt argument.

    Definition Classes
    Builder
  8. def bodyHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  9. def briefDesc[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A]): Chunk[Doc]

    Generate a brief help text for a parser.

    Generate a brief help text for a parser.

    Definition Classes
    Help
  10. def byteArgument(mod: Mod[ArgumentFields, Byte]*): optparse_applicative.types.Parser[Byte]

    Builder for a Byte argument.

    Builder for a Byte argument.

    Definition Classes
    Builder
  11. def byteOption(mod: Mod[OptionFields, Byte]*): optparse_applicative.types.Parser[Byte]

    Builder for an option taking a Byte argument.

    Builder for an option taking a Byte argument.

    Definition Classes
    Builder
  12. def charArgument(mod: Mod[ArgumentFields, Char]*): optparse_applicative.types.Parser[Char]

    Builder for a Char argument.

    Builder for a Char argument.

    Definition Classes
    Builder
  13. def charOption(mod: Mod[OptionFields, Char]*): optparse_applicative.types.Parser[Char]

    Builder for an option taking a Char argument.

    Builder for an option taking a Char argument.

    Definition Classes
    Builder
  14. def cmdDesc[A](p: optparse_applicative.types.Parser[A]): Chunk[Doc]

    Generate descriptions for commands.

    Generate descriptions for commands.

    Definition Classes
    Help
  15. def columns(cols: Int): PrefsMod
    Definition Classes
    Builder
  16. def command[A](cmd: String, info: optparse_applicative.types.ParserInfo[A]): Mod[CommandFields, A]

    Add a command to a subparser option.

    Add a command to a subparser option.

    Definition Classes
    Builder
  17. def customExecParser[A](args: List[String], progName: String, pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A]): A
    Definition Classes
    Extra
  18. def disabled[A]: ReadM[A]

    Null Option reader.

    Null Option reader. All arguments will fail validation.

    Definition Classes
    Builder
  19. val disambiguate: PrefsMod
    Definition Classes
    Builder
  20. def doubleArgument(mod: Mod[ArgumentFields, Double]*): optparse_applicative.types.Parser[Double]

    Builder for a Double argument.

    Builder for a Double argument.

    Definition Classes
    Builder
  21. def doubleOption(mod: Mod[OptionFields, Double]*): optparse_applicative.types.Parser[Double]

    Builder for an option taking a Double argument.

    Builder for an option taking a Double argument.

    Definition Classes
    Builder
  22. 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
  23. def errorHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  24. def evalParser[A](p: optparse_applicative.types.Parser[A]): Option[A]

    The default value of a Parser.

    The default value of a Parser. This function returns an error if any of the options don't have a default value

    Definition Classes
    Common
  25. def execParser[A](args: Array[String], progName: String, pinfo: optparse_applicative.types.ParserInfo[A]): A
    Definition Classes
    Extra
  26. def execParserPure[A](pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A], args: List[String]): ParserResult[A]
    Definition Classes
    Extra
  27. def failureCode[A](code: Int): InfoMod[A]
    Definition Classes
    Builder
  28. def flag[A](defV: A, actV: A, mod: Mod[FlagFields, A]*): optparse_applicative.types.Parser[A]

    Builder for a flag parser.

    Builder for a flag parser.

    Definition Classes
    Builder
  29. def flag_[A](actV: A, mod: Mod[FlagFields, A]*): optparse_applicative.types.Parser[A]

    Builder for a flag parser without a default value.

    Builder for a flag parser without a default value.

    Definition Classes
    Builder
  30. def floatArgument(mod: Mod[ArgumentFields, Float]*): optparse_applicative.types.Parser[Float]

    Builder for a Float argument.

    Builder for a Float argument.

    Definition Classes
    Builder
  31. def floatOption(mod: Mod[OptionFields, Float]*): optparse_applicative.types.Parser[Float]

    Builder for an option taking a Float argument.

    Builder for an option taking a Float argument.

    Definition Classes
    Builder
  32. def footer[A](footer: String): InfoMod[A]
    Definition Classes
    Builder
  33. def footerDoc[A](doc: Option[Doc]): InfoMod[A]
    Definition Classes
    Builder
  34. def footerHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  35. 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
  36. def fullDesc[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A]): Chunk[Doc]

    Generate a full help text for a parser.

    Generate a full help text for a parser.

    Definition Classes
    Help
  37. def getPolicy[A](i: optparse_applicative.types.ParserInfo[A]): ArgPolicy
    Definition Classes
    Common
  38. def handleParseResult[A](progName: String, result: ParserResult[A]): A
    Definition Classes
    Extra
  39. def header[A](header: String): InfoMod[A]
    Definition Classes
    Builder
  40. def headerDoc[A](doc: Option[Doc]): InfoMod[A]
    Definition Classes
    Builder
  41. def headerHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  42. 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
  43. def helpDoc[F[_], A](doc: Option[Doc]): Mod[F, A]

    Specify the help Doc.

    Specify the help Doc.

    Definition Classes
    Builder
  44. def helper[A]: optparse_applicative.types.Parser[(A) ⇒ A]

    A hidden "helper" option which always fails

    A hidden "helper" option which always fails

    Definition Classes
    Extra
  45. def hidden[F[_], A]: Mod[F, A]

    Hide this option from the brief description.

    Hide this option from the brief description.

    Definition Classes
    Builder
  46. def idm[M](implicit M: Monoid[M]): M

    Trivial option modifier.

    Trivial option modifier.

    Definition Classes
    Builder
  47. def info[A](parser: optparse_applicative.types.Parser[A], mod: InfoMod[A]*): optparse_applicative.types.ParserInfo[A]
    Definition Classes
    Builder
  48. def infoOption[A](s: String, mod: Mod[OptionFields, (A) ⇒ A]*): optparse_applicative.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
  49. def intArgument(mod: Mod[ArgumentFields, Int]*): optparse_applicative.types.Parser[Int]

    Builder for a Int argument.

    Builder for a Int argument.

    Definition Classes
    Builder
  50. def intOption(mod: Mod[OptionFields, Int]*): optparse_applicative.types.Parser[Int]

    Builder for an option taking a Int argument.

    Builder for an option taking a Int argument.

    Definition Classes
    Builder
  51. def isArg[A](r: OptReader[A]): Boolean
    Definition Classes
    Common
  52. def isOptionPrefix(n1: OptName, n2: OptName): Boolean
    Definition Classes
    Common
  53. def liftOpt[A](opt: Opt[A]): optparse_applicative.types.Parser[A]

    Create a parser composed of a single operation.

    Create a parser composed of a single operation.

    Definition Classes
    Common
  54. 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
  55. def longArgument(mod: Mod[ArgumentFields, Long]*): optparse_applicative.types.Parser[Long]

    Builder for a Long argument.

    Builder for a Long argument.

    Definition Classes
    Builder
  56. def longOption(mod: Mod[OptionFields, Long]*): optparse_applicative.types.Parser[Long]

    Builder for an option taking a Long argument.

    Builder for an option taking a Long argument.

    Definition Classes
    Builder
  57. def many[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[List[A]]
    Definition Classes
    ParserFunctions
  58. def mapParser[A, B](f: (OptHelpInfo) ⇒ ~>[Opt, [β$13$]Const[B, β$13$]], p: optparse_applicative.types.Parser[A]): List[B]

    Map a polymorphic function over all the options of a parser, and collect the results in a list.

    Map a polymorphic function over all the options of a parser, and collect the results in a list.

    Definition Classes
    Common
  59. 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
  60. def multiSuffix(suffix: String): PrefsMod
    Definition Classes
    Builder
  61. 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
  62. val noBacktrack: PrefsMod
    Definition Classes
    Builder
  63. def noIntersperse[A]: InfoMod[A]
    Definition Classes
    Builder
  64. def optDesc[A](pprefs: ParserPrefs, style: OptDescStyle, info: OptHelpInfo, opt: Opt[A]): Chunk[Doc]

    Generate description for a single option.

    Generate description for a single option.

    Definition Classes
    Help
  65. def optMatches[F[_], A](disambiguate: Boolean, opt: OptReader[A], word: OptWord)(implicit F: MonadP[F]): Option[StateT[F, Args, A]]
    Definition Classes
    Common
  66. def option[A](r: ReadM[A], mod: Mod[OptionFields, A]*): optparse_applicative.types.Parser[A]
    Definition Classes
    Builder
  67. def optional[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[Option[A]]
    Definition Classes
    ParserFunctions
  68. def parseError[F[_], A](arg: String)(implicit F: MonadP[F]): F[A]
    Definition Classes
    Common
  69. def parseWord(s: String): Option[OptWord]
    Definition Classes
    Common
  70. def parserFailure[A](pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A], msg: ParseError, ctx: Context): ParserFailure[ParserHelp]

    Generate a ParserFailure from a ParseError in a given Context.

    Generate a ParserFailure from a ParseError in a given Context.

    Definition Classes
    Extra
  71. def parserHelp[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A]): ParserHelp

    Generate the help text for a program.

    Generate the help text for a program.

    Definition Classes
    Help
  72. def parserUsage[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A], progName: String): Doc

    Generate option summary.

    Generate option summary.

    Definition Classes
    Help
  73. def prefs(mod: PrefsMod*): ParserPrefs
    Definition Classes
    Builder
  74. def progDesc[A](desc: String): InfoMod[A]

    Specify a short program description.

    Specify a short program description.

    Definition Classes
    Builder
  75. def progDescDoc[A](doc: Option[Doc]): InfoMod[A]
    Definition Classes
    Builder
  76. def pure[A](a: A): optparse_applicative.types.Parser[A]
    Definition Classes
    ParserFunctions
  77. val readBigDecimal: ReadM[BigDecimal]

    BigDecimal reader

    BigDecimal reader

    Definition Classes
    Builder
  78. val readBigInt: ReadM[BigInt]

    BigInt reader

    BigInt reader

    Definition Classes
    Builder
  79. val readByte: ReadM[Byte]

    Byte reader

    Byte reader

    Definition Classes
    Builder
  80. val readChar: ReadM[Char]

    Char reader

    Char reader

    Definition Classes
    Builder
  81. val readDouble: ReadM[Double]

    Double reader

    Double reader

    Definition Classes
    Builder
  82. val readFloat: ReadM[Float]

    Float reader

    Float reader

    Definition Classes
    Builder
  83. val readInt: ReadM[Int]

    Int reader.

    Int reader.

    Definition Classes
    Builder
  84. val readLong: ReadM[Long]

    Long reader

    Long reader

    Definition Classes
    Builder
  85. val readShort: ReadM[Short]

    Short reader

    Short reader

    Definition Classes
    Builder
  86. val readStr: ReadM[String]

    String reader.

    String reader.

    Definition Classes
    Builder
  87. def renderFailure(failure: ParserFailure[ParserHelp], progName: String): (String, ExitCode)
    Definition Classes
    Extra
  88. def runParser[F[_], A](policy: ArgPolicy, p: optparse_applicative.types.Parser[A], args: Args)(implicit F: MonadP[F]): F[(Args, A)]

    Apply a Parser to a command line, and return a result and leftover arguments.

    Apply a Parser to a command line, and return a result and leftover arguments. This function returns an error if any parsing error occurs, or if any options are missing and don't have a default value.

    Definition Classes
    Common
  89. def runParserFully[F[_], A](policy: ArgPolicy, p: optparse_applicative.types.Parser[A], args: Args)(implicit arg0: MonadP[F]): F[A]
    Definition Classes
    Common
  90. def runParserInfo[F[_], A](i: optparse_applicative.types.ParserInfo[A], args: Args)(implicit arg0: MonadP[F]): F[A]
    Definition Classes
    Common
  91. def searchArg[F[_], A](arg: String, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[F, List[String], List[String], A], optparse_applicative.types.Parser[A]]
    Definition Classes
    Common
  92. def searchOpt[F[_], A](pprefs: ParserPrefs, w: OptWord, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[F, List[String], List[String], A], optparse_applicative.types.Parser[A]]
    Definition Classes
    Common
  93. def searchParser[F[_], A](f: ~>[Opt, [β$10$]NondetT[F, β$10$]], p: optparse_applicative.types.Parser[A])(implicit arg0: Monad[F]): NondetT[F, optparse_applicative.types.Parser[A]]
    Definition Classes
    Common
  94. 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
  95. def shortArgument(mod: Mod[ArgumentFields, Short]*): optparse_applicative.types.Parser[Short]

    Builder for a Short argument.

    Builder for a Short argument.

    Definition Classes
    Builder
  96. def shortOption(mod: Mod[OptionFields, Short]*): optparse_applicative.types.Parser[Short]

    Builder for an option taking a Short argument.

    Builder for an option taking a Short argument.

    Definition Classes
    Builder
  97. 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
  98. 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
  99. val showHelpOnError: PrefsMod
    Definition Classes
    Builder
  100. def showOption(name: OptName): String
    Definition Classes
    Common
  101. def simplify[A](as: OptTree[A]): OptTree[A]
    Definition Classes
    Common
  102. def some[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[NonEmptyList[A]]
    Definition Classes
    ParserFunctions
  103. def stepParser[F[_], A](pprefs: ParserPrefs, policy: ArgPolicy, arg: String, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[F, List[String], List[String], A], optparse_applicative.types.Parser[A]]
    Definition Classes
    Common
  104. def strArgument(mod: Mod[ArgumentFields, String]*): optparse_applicative.types.Parser[String]

    Builder for a String argument.

    Builder for a String argument.

    Definition Classes
    Builder
  105. def strOption(mod: Mod[OptionFields, String]*): optparse_applicative.types.Parser[String]

    Builder for an option taking a String argument.

    Builder for an option taking a String argument.

    Definition Classes
    Builder
  106. def subparser[A](mod: Mod[CommandFields, A]*): optparse_applicative.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
  107. def switch(mod: Mod[FlagFields, Boolean]*): optparse_applicative.types.Parser[Boolean]

    Builder for a boolean flag.

    Builder for a boolean flag.

    Definition Classes
    Builder
  108. def treeMapParser[A, B](g: (OptHelpInfo) ⇒ ~>[Opt, [β$14$]Const[B, β$14$]], p: optparse_applicative.types.Parser[A]): OptTree[B]

    Like mapParser, but collect the results in a tree structure.

    Like mapParser, but collect the results in a tree structure.

    Definition Classes
    Common
  109. def usageHelp(chunk: Chunk[Doc]): ParserHelp
    Definition Classes
    Help
  110. 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

Inherited from ParserFunctions

Inherited from Help

Inherited from Extra

Inherited from Common

Inherited from Builder

Inherited from AnyRef

Inherited from Any

Ungrouped