package types
- Source
- package.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- types
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- case class AltNode[A](as: List[OptTree[A]]) extends OptTree[A] with Product with Serializable
- case class AltP[A](p1: Parser[A], p2: Parser[A]) extends Parser[A] with Product with Serializable
- sealed trait ArgPolicy extends AnyRef
- case class ArgReader[A](cr: CReader[A]) extends OptReader[A] with Product with Serializable
- type Args = List[String]
- case class BindP[A, B](p: Parser[A], f: (A) => Parser[B]) extends Parser[B] with Product with Serializable
- final case class CReader[A](reader: ReadM[A]) extends Product with Serializable
- case class CmdReader[A](ns: List[String], f: (String) => Option[ParserInfo[A]]) extends OptReader[A] with Product with Serializable
- class Doc extends AnyRef
- case class ErrorMsg(msg: String) extends ParseError with Product with Serializable
- sealed trait ExitCode extends AnyRef
- case class ExitFailure(code: Int) extends ExitCode with Product with Serializable
- case class Failure[A](failure: ParserFailure[ParserHelp]) extends ParserResult[A] with Product with Serializable
- case class FlagReader[A](ns: List[OptName], a: A) extends OptReader[A] with Product with Serializable
- case class InfoMsg(msg: String) extends ParseError with Product with Serializable
- case class Leaf[A](a: A) extends OptTree[A] with Product with Serializable
- case class MultNode[A](as: List[OptTree[A]]) extends OptTree[A] with Product with Serializable
- case class MultP[A, B](p1: Parser[(A) => B], p2: Parser[A]) extends Parser[B] with Product with Serializable
- case class NilP[A](fa: Option[A]) extends Parser[A] with Product with Serializable
- final case class Opt[A](main: OptReader[A], props: OptProperties) extends Product with Serializable
A single option of a parser.
- final case class OptHelpInfo(multi: Boolean, default: Boolean) extends Product with Serializable
- case class OptLong(name: String) extends OptName with Product with Serializable
- sealed trait OptName extends AnyRef
- case class OptP[A](fa: Opt[A]) extends Parser[A] with Product with Serializable
- final case class OptProperties(visibility: OptVisibility, help: Chunk[Doc], metaVar: String, showDefault: Option[String]) extends Product with Serializable
Specification for an individual parser option.
- sealed trait OptReader[A] extends AnyRef
- case class OptShort(name: Char) extends OptName with Product with Serializable
- sealed trait OptTree[A] extends AnyRef
- sealed trait OptVisibility extends Ordered[OptVisibility]
- case class OptionReader[A](ns: List[OptName], cr: CReader[A], e: ParseError) extends OptReader[A] with Product with Serializable
- sealed trait ParseError extends AnyRef
- sealed trait Parser[A] extends AnyRef
- case class ParserFailure[H](run: (String) => (H, ExitCode, Int)) extends Product with Serializable
- final case class ParserInfo[A](parser: Parser[A], fullDesc: Boolean, progDesc: Chunk[Doc], header: Chunk[Doc], footer: Chunk[Doc], failureCode: Int, intersperse: Boolean) extends Product with Serializable
A full description for a runnable Parser for a program.
A full description for a runnable Parser for a program.
- parser
the option parser for the program
- fullDesc
whether the help text should contain full documentation
- failureCode
exit code for a parser failure
- trait ParserM[R] extends AnyRef
- final case class ParserPrefs(multiSuffix: String, disambiguate: Boolean = false, showHelpOnError: Boolean = false, backtrack: Boolean = false, columns: Int = 80) extends Product with Serializable
- multiSuffix
metavar suffix for multiple options
- disambiguate
automatically disambiguate abbreviations
- showHelpOnError
show help text on parse errors
- backtrack
backtrack to parent parser when a subcommand fails
- columns
format the help page
- sealed trait ParserResult[A] extends AnyRef
- final case class ReadM[A](run: ReaderT[[β$1$]\/[ParseError, β$1$], String, A]) extends Product with Serializable
A newtype over the Either monad used by option readers.
- case class Success[A](a: A) extends ParserResult[A] with Product with Serializable
Value Members
- object AllowOpts extends ArgPolicy with Product with Serializable
- object CReader extends Serializable
- object Doc
- object ExitSuccess extends ExitCode with Product with Serializable
- object Hidden extends OptVisibility with Product with Serializable
- object Internal extends OptVisibility with Product with Serializable
- object Opt extends Serializable
- object OptName
- object OptReader
- object ParseError
- object Parser extends ParserInstances with ParserFunctions
- object ParserFailure extends Serializable
- object ParserInfo extends Serializable
- object ParserM
- object ReadM extends Serializable
- object ShowHelpText extends ParseError with Product with Serializable
- object SkipOpts extends ArgPolicy with Product with Serializable
- object UnknownError extends ParseError with Product with Serializable
- object Visible extends OptVisibility with Product with Serializable