optparse-applicative
API
Generated with
optparse-applicative/optparse_applicative/optparse_applicative.types

optparse_applicative.types

package optparse_applicative.types

Members list

Type members

Classlikes

case object AllowOpts extends ArgPolicy

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait ArgPolicy
class Object
trait Matchable
class Any
Show all
Self type
AllowOpts.type
case class AltNode[A](as: List[OptTree[A]]) extends OptTree[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptTree[A]
class Object
trait Matchable
class Any
Show all
case class AltP[A](p1: Parser[A], p2: Parser[A]) extends Parser[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[A]
class Object
trait Matchable
class Any
Show all
sealed trait ArgPolicy

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AllowOpts
object SkipOpts
case class ArgReader[A](cr: CReader[A]) extends OptReader[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptReader[A]
class Object
trait Matchable
class Any
Show all
case class BindP[A, B](p: Parser[A], f: A => Parser[B]) extends Parser[B]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[B]
class Object
trait Matchable
class Any
Show all
final case class CReader[A](reader: ReadM[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CReader

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CReader.type
case class CmdReader[A](ns: List[String], f: String => Option[ParserInfo[A]]) extends OptReader[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptReader[A]
class Object
trait Matchable
class Any
Show all
object Doc

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Doc.type
class Doc(step: Cont)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
Doc
case class ErrorMsg(msg: String) extends ParseError

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParseError
class Object
trait Matchable
class Any
Show all
sealed trait ExitCode

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ExitFailure
object ExitSuccess
case class ExitFailure(code: Int) extends ExitCode

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ExitCode
class Object
trait Matchable
class Any
Show all
case object ExitSuccess extends ExitCode

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait ExitCode
class Object
trait Matchable
class Any
Show all
Self type
case class Failure[A](failure: ParserFailure[ParserHelp]) extends ParserResult[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParserResult[A]
class Object
trait Matchable
class Any
Show all
case class FlagReader[A](ns: List[OptName], a: A) extends OptReader[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptReader[A]
class Object
trait Matchable
class Any
Show all
case object Hidden extends OptVisibility

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Ordered[OptVisibility]
trait Comparable[OptVisibility]
class Object
trait Matchable
class Any
Show all
Self type
Hidden.type
case class InfoMsg(msg: String) extends ParseError

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParseError
class Object
trait Matchable
class Any
Show all
case object Internal extends OptVisibility

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Ordered[OptVisibility]
trait Comparable[OptVisibility]
class Object
trait Matchable
class Any
Show all
Self type
Internal.type
case class Leaf[A](a: A) extends OptTree[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptTree[A]
class Object
trait Matchable
class Any
Show all
case class MultNode[A](as: List[OptTree[A]]) extends OptTree[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptTree[A]
class Object
trait Matchable
class Any
Show all
sealed abstract case class MultP[B] extends Parser[B]

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[B]
class Object
trait Matchable
class Any
Show all
object MultP

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
MultP.type
case class NilP[A](fa: Option[A]) extends Parser[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[A]
class Object
trait Matchable
class Any
Show all
final case class Opt[A](main: OptReader[A], props: OptProperties)

A single option of a parser.

A single option of a parser.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Opt

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Opt.type
final case class OptHelpInfo(multi: Boolean, default: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OptLong(name: String) extends OptName

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptName
class Object
trait Matchable
class Any
Show all
sealed trait OptName

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class OptLong
class OptShort
object OptName

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
OptName.type
case class OptP[A](fa: Opt[A]) extends Parser[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[A]
class Object
trait Matchable
class Any
Show all
final case class OptProperties(visibility: OptVisibility, help: Chunk[Doc], metaVar: String, showDefault: Option[String])

Specification for an individual parser option.

Specification for an individual parser option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait OptReader[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ArgReader[A]
class CmdReader[A]
class FlagReader[A]
class OptionReader[A]
object OptReader

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
OptReader.type
case class OptShort(name: Char) extends OptName

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptName
class Object
trait Matchable
class Any
Show all
sealed trait OptTree[A]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AltNode[A]
class Leaf[A]
class MultNode[A]
sealed trait OptVisibility extends Ordered[OptVisibility]

Attributes

Supertypes
trait Ordered[OptVisibility]
trait Comparable[OptVisibility]
class Object
trait Matchable
class Any
Known subtypes
object Hidden
object Internal
object Visible
case class OptionReader[A](ns: List[OptName], cr: CReader[A], e: ParseError) extends OptReader[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptReader[A]
class Object
trait Matchable
class Any
Show all
sealed trait ParseError

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ErrorMsg
class InfoMsg
object ShowHelpText
object UnknownError
object ParseError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ParseError.type
sealed trait Parser[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AltP[A]
class BindP[A, B]
class MultP[B]
class NilP[A]
class OptP[A]
object Parser

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Parser.type
case class ParserFailure[H](run: String => (H, ExitCode, Int))

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParserFailure

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ParserInfo[A](parser: Parser[A], fullDesc: Boolean, progDesc: Chunk[Doc], header: Chunk[Doc], footer: Chunk[Doc], failureCode: Int, intersperse: Boolean)

A full description for a runnable Parser for a program.

A full description for a runnable Parser for a program.

Value parameters

failureCode

exit code for a parser failure

fullDesc

whether the help text should contain full documentation

parser

the option parser for the program

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParserInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ParserInfo.type
trait ParserM[R]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ParserM

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ParserM.type
final case class ParserPrefs(multiSuffix: String, disambiguate: Boolean, showHelpOnError: Boolean, backtrack: Boolean, columns: Int)

Value parameters

backtrack

backtrack to parent parser when a subcommand fails

columns

format the help page

disambiguate

automatically disambiguate abbreviations

multiSuffix

metavar suffix for multiple options

showHelpOnError

show help text on parse errors

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ParserResult[A]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Failure[A]
class Success[A]
final case class ReadM[A](run: ReaderT[String, [_] =>> ParseError \/ _$1, A])

A newtype over the Either monad used by option readers.

A newtype over the Either monad used by option readers.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReadM

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ReadM.type
case object ShowHelpText extends ParseError

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait ParseError
class Object
trait Matchable
class Any
Show all
Self type
case object SkipOpts extends ArgPolicy

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait ArgPolicy
class Object
trait Matchable
class Any
Show all
Self type
SkipOpts.type
case class Success[A](a: A) extends ParserResult[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ParserResult[A]
class Object
trait Matchable
class Any
Show all
case object UnknownError extends ParseError

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait ParseError
class Object
trait Matchable
class Any
Show all
Self type
case object Visible extends OptVisibility

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Ordered[OptVisibility]
trait Comparable[OptVisibility]
class Object
trait Matchable
class Any
Show all
Self type
Visible.type

Types

type Args = List[String]
Generated with