optparse_applicative
package optparse_applicative
- Source
- package.scala
- Alphabetic
- By Inheritance
- optparse_applicative
- ParserFunctions
- Help
- Extra
- Common
- Builder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
Type Members
- trait ArgsState[F[_]] extends AnyRef
- Definition Classes
- Common
- type InfoMod[A] = Endo[optparse_applicative.types.ParserInfo[A]]
- Definition Classes
- Builder
- type Parser[A] = optparse_applicative.types.Parser[A]
- type ParserInfo[A] = optparse_applicative.types.ParserInfo[A]
- type PrefsMod = Endo[ParserPrefs]
- Definition Classes
- Builder
Value Members
- 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
- def argMatches[F[_], A](opt: OptReader[A], arg: String)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]
- Definition Classes
- Common
- 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
- def bigDecimalArgument(mod: Mod[ArgumentFields, BigDecimal]*): optparse_applicative.types.Parser[BigDecimal]
Builder for a BigDecimal argument.
Builder for a BigDecimal argument.
- Definition Classes
- Builder
- 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
- def bigIntArgument(mod: Mod[ArgumentFields, BigInt]*): optparse_applicative.types.Parser[BigInt]
Builder for a BigInt argument.
Builder for a BigInt argument.
- Definition Classes
- Builder
- 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
- def bodyHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- 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
- def byteArgument(mod: Mod[ArgumentFields, Byte]*): optparse_applicative.types.Parser[Byte]
Builder for a Byte argument.
Builder for a Byte argument.
- Definition Classes
- Builder
- 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
- def charArgument(mod: Mod[ArgumentFields, Char]*): optparse_applicative.types.Parser[Char]
Builder for a Char argument.
Builder for a Char argument.
- Definition Classes
- Builder
- 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
- def cmdDesc[A](p: optparse_applicative.types.Parser[A]): Chunk[Doc]
Generate descriptions for commands.
Generate descriptions for commands.
- Definition Classes
- Help
- def columns(cols: Int): PrefsMod
- Definition Classes
- Builder
- 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
- def customExecParser[A](args: List[String], progName: String, pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A]): A
- Definition Classes
- Extra
- 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]*): optparse_applicative.types.Parser[Double]
Builder for a Double argument.
Builder for a Double argument.
- Definition Classes
- Builder
- 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
- 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 errorHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- 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
- def execParser[A](args: Array[String], progName: String, pinfo: optparse_applicative.types.ParserInfo[A]): A
- Definition Classes
- Extra
- def execParserPure[A](pprefs: ParserPrefs, pinfo: optparse_applicative.types.ParserInfo[A], args: List[String]): ParserResult[A]
- Definition Classes
- Extra
- def failureCode[A](code: Int): InfoMod[A]
- Definition Classes
- Builder
- 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
- 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
- def floatArgument(mod: Mod[ArgumentFields, Float]*): optparse_applicative.types.Parser[Float]
Builder for a Float argument.
Builder for a Float argument.
- Definition Classes
- Builder
- 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
- def footer[A](footer: String): InfoMod[A]
- Definition Classes
- Builder
- def footerDoc[A](doc: Option[Doc]): InfoMod[A]
- Definition Classes
- Builder
- def footerHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- 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 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
- def getPolicy[A](i: optparse_applicative.types.ParserInfo[A]): ArgPolicy
- Definition Classes
- Common
- def handleParseResult[A](progName: String, result: ParserResult[A]): A
- Definition Classes
- Extra
- def header[A](header: String): InfoMod[A]
- Definition Classes
- Builder
- def headerDoc[A](doc: Option[Doc]): InfoMod[A]
- Definition Classes
- Builder
- def headerHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- 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 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
- 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: optparse_applicative.types.Parser[A], mod: InfoMod[A]*): optparse_applicative.types.ParserInfo[A]
- Definition Classes
- Builder
- 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
- def intArgument(mod: Mod[ArgumentFields, Int]*): optparse_applicative.types.Parser[Int]
Builder for a Int argument.
Builder for a Int argument.
- Definition Classes
- Builder
- 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
- def isArg[A](r: OptReader[A]): Boolean
- Definition Classes
- Common
- def isOptionPrefix(n1: OptName, n2: OptName): Boolean
- Definition Classes
- Common
- 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
- 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]*): optparse_applicative.types.Parser[Long]
Builder for a Long argument.
Builder for a Long argument.
- Definition Classes
- Builder
- 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
- def many[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[List[A]]
- Definition Classes
- ParserFunctions
- 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
- 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 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
- def optMatches[F[_], A](disambiguate: Boolean, opt: OptReader[A], word: OptWord)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]
- Definition Classes
- Common
- def option[A](r: ReadM[A], mod: Mod[OptionFields, A]*): optparse_applicative.types.Parser[A]
- Definition Classes
- Builder
- def optional[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[Option[A]]
- Definition Classes
- ParserFunctions
- def parseError[F[_], A](arg: String)(implicit F: MonadP[F]): F[A]
- Definition Classes
- Common
- def parseWord(s: String): Option[OptWord]
- Definition Classes
- Common
- 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
- 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
- def parserUsage[A](pprefs: ParserPrefs, parser: optparse_applicative.types.Parser[A], progName: String): Doc
Generate option summary.
Generate option summary.
- Definition Classes
- Help
- 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
- def pure[A](a: A): optparse_applicative.types.Parser[A]
- Definition Classes
- ParserFunctions
- 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 renderFailure(failure: ParserFailure[ParserHelp], progName: String): (String, ExitCode)
- Definition Classes
- Extra
- 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
- def runParserFully[F[_], A](policy: ArgPolicy, p: optparse_applicative.types.Parser[A], args: Args)(implicit arg0: MonadP[F]): F[A]
- Definition Classes
- Common
- def runParserInfo[F[_], A](i: optparse_applicative.types.ParserInfo[A], args: Args)(implicit arg0: MonadP[F]): F[A]
- Definition Classes
- Common
- 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
- 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
- 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
- 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]*): optparse_applicative.types.Parser[Short]
Builder for a Short argument.
Builder for a Short argument.
- Definition Classes
- Builder
- 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
- 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 showOption(name: OptName): String
- Definition Classes
- Common
- def simplify[A](as: OptTree[A]): OptTree[A]
- Definition Classes
- Common
- def some[A](p: optparse_applicative.types.Parser[A]): optparse_applicative.types.Parser[NonEmptyList[A]]
- Definition Classes
- ParserFunctions
- 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
- def strArgument(mod: Mod[ArgumentFields, String]*): optparse_applicative.types.Parser[String]
Builder for a String argument.
Builder for a String argument.
- Definition Classes
- Builder
- 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
- 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
- def switch(mod: Mod[FlagFields, Boolean]*): optparse_applicative.types.Parser[Boolean]
Builder for a boolean flag.
Builder for a boolean flag.
- Definition Classes
- Builder
- 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
- def usageHelp(chunk: Chunk[Doc]): ParserHelp
- Definition Classes
- Help
- 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