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

optparse_applicative.common

package optparse_applicative.common

Members list

Type members

Classlikes

case class Match(s: Option[String]) extends MatchResult

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Match
object NoMatch
object MatchResult

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case object NoMatch extends MatchResult

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait MatchResult
class Object
trait Matchable
class Any
Show all
Self type
NoMatch.type
final case class OptWord(name: OptName, value: Option[String])

Attributes

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

Inherited classlikes

trait ArgsState[F[_]]

Attributes

Inherited from:
Common (hidden)
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

def argMatches[F[_], A](opt: OptReader[A], arg: String)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]

Attributes

Inherited from:
Common (hidden)
def evalParser[A](p: Parser[A]): Option[A]

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

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

Attributes

Inherited from:
Common (hidden)
def getPolicy[A](i: ParserInfo[A]): ArgPolicy

Attributes

Inherited from:
Common (hidden)
def isArg[A](r: OptReader[A]): Boolean

Attributes

Inherited from:
Common (hidden)
def isOptionPrefix(n1: OptName, n2: OptName): Boolean

Attributes

Inherited from:
Common (hidden)
def liftOpt[A](opt: Opt[A]): Parser[A]

Create a parser composed of a single operation.

Create a parser composed of a single operation.

Attributes

Inherited from:
Common (hidden)
def mapParser[A, B](f: OptHelpInfo => NaturalTransformation[Opt, [_] =>> Const[B, _$23]], p: 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.

Attributes

Inherited from:
Common (hidden)
def optMatches[F[_], A](disambiguate: Boolean, opt: OptReader[A], word: OptWord)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]

Attributes

Inherited from:
Common (hidden)
def parseError[F[_], A](arg: String)(implicit F: MonadP[F]): F[A]

Attributes

Inherited from:
Common (hidden)
def parseWord(s: String): Option[OptWord]

Attributes

Inherited from:
Common (hidden)
def runParser[F[_], A](policy: ArgPolicy, p: 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. This function returns an error if any parsing error occurs, or if any options are missing and don't have a default value.

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.

Attributes

Inherited from:
Common (hidden)
def runParserFully[F[_] : MonadP, A](policy: ArgPolicy, p: Parser[A], args: Args): F[A]

Attributes

Inherited from:
Common (hidden)
def runParserInfo[F[_] : MonadP, A](i: ParserInfo[A], args: Args): F[A]

Attributes

Inherited from:
Common (hidden)
def searchArg[F[_] : MonadP, A](arg: String, p: Parser[A]): NondetT[ArgsState[F]#G, Parser[A]]

Attributes

Inherited from:
Common (hidden)
def searchOpt[F[_] : MonadP, A](pprefs: ParserPrefs, w: OptWord, p: Parser[A]): NondetT[ArgsState[F]#G, Parser[A]]

Attributes

Inherited from:
Common (hidden)
def searchParser[F[_] : Monad, A](f: NaturalTransformation[Opt, [_] =>> NondetT[F, _$17]], p: Parser[A]): NondetT[F, Parser[A]]

Attributes

Inherited from:
Common (hidden)
def showOption(name: OptName): String

Attributes

Inherited from:
Common (hidden)
def simplify[A](as: OptTree[A]): OptTree[A]

Attributes

Inherited from:
Common (hidden)
def stepParser[F[_] : MonadP, A](pprefs: ParserPrefs, policy: ArgPolicy, arg: String, p: Parser[A]): NondetT[ArgsState[F]#G, Parser[A]]

Attributes

Inherited from:
Common (hidden)
def treeMapParser[A, B](g: OptHelpInfo => NaturalTransformation[Opt, [_] =>> Const[B, _$24]], p: Parser[A]): OptTree[B]

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

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

Attributes

Inherited from:
Common (hidden)
Generated with