optparse_applicative

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[Args, F, 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. package builder

    

11. def byteArgument(mod: Mod[ArgumentFields, Byte]*): optparse_applicative.types.Parser[Byte]

    

    Builder for a Byte argument.

    Builder for a Byte argument.

    Definition Classes

    Builder

12. 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

13. def charArgument(mod: Mod[ArgumentFields, Char]*): optparse_applicative.types.Parser[Char]

    

    Builder for a Char argument.

    Builder for a Char argument.

    Definition Classes

    Builder

14. 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

15. def cmdDesc[A](p: optparse_applicative.types.Parser[A]): Chunk[Doc]

    

    Generate descriptions for commands.

    Generate descriptions for commands.

    Definition Classes

    Help

16. def columns(cols: Int): PrefsMod

    

    Definition Classes

    Builder

17. 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

18. package common

    

19. def customExecParser[A](args: List[String], progName: String, pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A]): A

    

    Definition Classes

    Extra

20. def disabled[A]: ReadM[A]

    

    Null Option reader.

    Null Option reader. All arguments will fail validation.

    Definition Classes

    Builder

21. val disambiguate: PrefsMod

    

    Definition Classes

    Builder

22. def doubleArgument(mod: Mod[ArgumentFields, Double]*): optparse_applicative.types.Parser[Double]

    

    Builder for a Double argument.

    Builder for a Double argument.

    Definition Classes

    Builder

23. 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

24. 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

25. def errorHelp(chunk: Chunk[Doc]): ParserHelp

    

    Definition Classes

    Help

26. 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

27. def execParser[A](args: Array[String], progName: String, pinfo: optparse_applicative.types.ParserInfo[A]): A

    

    Definition Classes

    Extra

28. def execParserPure[A](pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A], args: List[String]): ParserResult[A]

    

    Definition Classes

    Extra

29. def failureCode[A](code: Int): InfoMod[A]

    

    Definition Classes

    Builder

30. 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

31. 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

32. def floatArgument(mod: Mod[ArgumentFields, Float]*): optparse_applicative.types.Parser[Float]

    

    Builder for a Float argument.

    Builder for a Float argument.

    Definition Classes

    Builder

33. 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

34. def footer[A](footer: String): InfoMod[A]

    

    Definition Classes

    Builder

35. def footerDoc[A](doc: Option[Doc]): InfoMod[A]

    

    Definition Classes

    Builder

36. def footerHelp(chunk: Chunk[Doc]): ParserHelp

    

    Definition Classes

    Help

37. 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

38. 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

39. def getPolicy[A](i: optparse_applicative.types.ParserInfo[A]): ArgPolicy

    

    Definition Classes

    Common

40. def handleParseResult[A](progName: String, result: ParserResult[A]): A

    

    Definition Classes

    Extra

41. def header[A](header: String): InfoMod[A]

    

    Definition Classes

    Builder

42. def headerDoc[A](doc: Option[Doc]): InfoMod[A]

    

    Definition Classes

    Builder

43. def headerHelp(chunk: Chunk[Doc]): ParserHelp

    

    Definition Classes

    Help

44. 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

45. def helpDoc[F[_], A](doc: Option[Doc]): Mod[F, A]

    

    Specify the help Doc.

    Specify the help Doc.

    Definition Classes

    Builder

46. package helpdoc

    

47. 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

48. def hidden[F[_], A]: Mod[F, A]

    

    Hide this option from the brief description.

    Hide this option from the brief description.

    Definition Classes

    Builder

49. def idm[M](implicit M: Monoid[M]): M

    

    Trivial option modifier.

    Trivial option modifier.

    Definition Classes

    Builder

50. def info[A](parser: optparse_applicative.types.Parser[A], mod: InfoMod[A]*): optparse_applicative.types.ParserInfo[A]

    

    Definition Classes

    Builder

51. 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

52. def intArgument(mod: Mod[ArgumentFields, Int]*): optparse_applicative.types.Parser[Int]

    

    Builder for a Int argument.

    Builder for a Int argument.

    Definition Classes

    Builder

53. 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

54. package internal

    

55. def isArg[A](r: OptReader[A]): Boolean

    

    Definition Classes

    Common

56. def isOptionPrefix(n1: OptName, n2: OptName): Boolean

    

    Definition Classes

    Common

57. 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

58. 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

59. def longArgument(mod: Mod[ArgumentFields, Long]*): optparse_applicative.types.Parser[Long]

    

    Builder for a Long argument.

    Builder for a Long argument.

    Definition Classes

    Builder

60. 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

61. def many[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[List[A]]

    

    Definition Classes

    ParserFunctions

62. def mapParser[A, B](f: (OptHelpInfo) ⇒ ~>[Opt, [β$7$]Const[B, β$7$]], 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

63. 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

64. def multiSuffix(suffix: String): PrefsMod

    

    Definition Classes

    Builder

65. 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

66. val noBacktrack: PrefsMod

    

    Definition Classes

    Builder

67. def noIntersperse[A]: InfoMod[A]

    

    Definition Classes

    Builder

68. 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

69. def optMatches[F[_], A](disambiguate: Boolean, opt: OptReader[A], word: OptWord)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]

    

    Definition Classes

    Common

70. def option[A](r: ReadM[A], mod: Mod[OptionFields, A]*): optparse_applicative.types.Parser[A]

    

    Definition Classes

    Builder

71. def optional[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[Option[A]]

    

    Definition Classes

    ParserFunctions

72. def parseError[F[_], A](arg: String)(implicit F: MonadP[F]): F[A]

    

    Definition Classes

    Common

73. def parseWord(s: String): Option[OptWord]

    

    Definition Classes

    Common

74. 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

75. 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

76. def parserUsage[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A], progName: String): Doc

    

    Generate option summary.

    Generate option summary.

    Definition Classes

    Help

77. def prefs(mod: PrefsMod*): ParserPrefs

    

    Definition Classes

    Builder

78. def progDesc[A](desc: String): InfoMod[A]

    

    Specify a short program description.

    Specify a short program description.

    Definition Classes

    Builder

79. def progDescDoc[A](doc: Option[Doc]): InfoMod[A]

    

    Definition Classes

    Builder

80. def pure[A](a: A): optparse_applicative.types.Parser[A]

    

    Definition Classes

    ParserFunctions

81. val readBigDecimal: ReadM[BigDecimal]

    

    BigDecimal reader

    BigDecimal reader

    Definition Classes

    Builder

82. val readBigInt: ReadM[BigInt]

    

    BigInt reader

    BigInt reader

    Definition Classes

    Builder

83. val readByte: ReadM[Byte]

    

    Byte reader

    Byte reader

    Definition Classes

    Builder

84. val readChar: ReadM[Char]

    

    Char reader

    Char reader

    Definition Classes

    Builder

85. val readDouble: ReadM[Double]

    

    Double reader

    Double reader

    Definition Classes

    Builder

86. val readFloat: ReadM[Float]

    

    Float reader

    Float reader

    Definition Classes

    Builder

87. val readInt: ReadM[Int]

    

    Int reader.

    Int reader.

    Definition Classes

    Builder

88. val readLong: ReadM[Long]

    

    Long reader

    Long reader

    Definition Classes

    Builder

89. val readShort: ReadM[Short]

    

    Short reader

    Short reader

    Definition Classes

    Builder

90. val readStr: ReadM[String]

    

    String reader.

    String reader.

    Definition Classes

    Builder

91. def renderFailure(failure: ParserFailure[ParserHelp], progName: String): (String, ExitCode)

    

    Definition Classes

    Extra

92. 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

93. def runParserFully[F[_], A](policy: ArgPolicy, p: optparse_applicative.types.Parser[A], args: Args)(implicit arg0: MonadP[F]): F[A]

    

    Definition Classes

    Common

94. def runParserInfo[F[_], A](i: optparse_applicative.types.ParserInfo[A], args: Args)(implicit arg0: MonadP[F]): F[A]

    

    Definition Classes

    Common

95. def searchArg[F[_], A](arg: String, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[List[String], List[String], F, A], optparse_applicative.types.Parser[A]]

    

    Definition Classes

    Common

96. def searchOpt[F[_], A](pprefs: ParserPrefs, w: OptWord, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[List[String], List[String], F, A], optparse_applicative.types.Parser[A]]

    

    Definition Classes

    Common

97. def searchParser[F[_], A](f: ~>[Opt, [β$4$]NondetT[F, β$4$]], p: optparse_applicative.types.Parser[A])(implicit arg0: Monad[F]): NondetT[F, optparse_applicative.types.Parser[A]]

    

    Definition Classes

    Common

98. 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

99. def shortArgument(mod: Mod[ArgumentFields, Short]*): optparse_applicative.types.Parser[Short]

    

    Builder for a Short argument.

    Builder for a Short argument.

    Definition Classes

    Builder

100. 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

101. 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

102. 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

103. val showHelpOnError: PrefsMod

     

     Definition Classes

     Builder

104. def showOption(name: OptName): String

     

     Definition Classes

     Common

105. def simplify[A](as: OptTree[A]): OptTree[A]

     

     Definition Classes

     Common

106. def some[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[NonEmptyList[A]]

     

     Definition Classes

     ParserFunctions

107. def stepParser[F[_], A](pprefs: ParserPrefs, policy: ArgPolicy, arg: String, p: optparse_applicative.types.Parser[A])(implicit arg0: MonadP[F]): NondetT[[A]IndexedStateT[List[String], List[String], F, A], optparse_applicative.types.Parser[A]]

     

     Definition Classes

     Common

108. def strArgument(mod: Mod[ArgumentFields, String]*): optparse_applicative.types.Parser[String]

     

     Builder for a String argument.

     Builder for a String argument.

     Definition Classes

     Builder

109. 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

110. 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

111. def switch(mod: Mod[FlagFields, Boolean]*): optparse_applicative.types.Parser[Boolean]

     

     Builder for a boolean flag.

     Builder for a boolean flag.

     Definition Classes

     Builder

112. def treeMapParser[A, B](g: (OptHelpInfo) ⇒ ~>[Opt, [β$8$]Const[B, β$8$]], 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

113. package types

     

114. def usageHelp(chunk: Chunk[Doc]): ParserHelp

     

     Definition Classes

     Help

115. 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