optparse-applicative/optparse_applicative.common

optparse_applicative.common

package optparse_applicative.common

Type members

Classlikes

case class Match(s: Option[String]) extends MatchResult
sealed trait MatchResult
Companion
object
object MatchResult
Companion
class
case object NoMatch extends MatchResult
final case class OptWord(name: OptName, value: Option[String])

Inherited classlikes

trait ArgsState[F[_]]
Inherited from
Common

Value members

Inherited methods

def argMatches[F[_], A](opt: OptReader[A], arg: String)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]
Inherited from
Common
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

Inherited from
Common
def getPolicy[A](i: ParserInfo[A]): ArgPolicy
Inherited from
Common
def isArg[A](r: OptReader[A]): Boolean
Inherited from
Common
def isOptionPrefix(n1: OptName, n2: OptName): Boolean
Inherited from
Common
def liftOpt[A](opt: Opt[A]): Parser[A]

Create a parser composed of a single operation.

Create a parser composed of a single operation.

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

Inherited from
Common
def optMatches[F[_], A](disambiguate: Boolean, opt: OptReader[A], word: OptWord)(implicit F: MonadP[F]): Option[StateT[Args, F, A]]
Inherited from
Common
def parseError[F[_], A](arg: String)(implicit F: MonadP[F]): F[A]
Inherited from
Common
def parseWord(s: String): Option[OptWord]
Inherited from
Common
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.

Inherited from
Common
def runParserFully[F[_], A](policy: ArgPolicy, p: Parser[A], args: Args)(implicit evidence$7: MonadP[F]): F[A]
Inherited from
Common
def runParserInfo[F[_], A](i: ParserInfo[A], args: Args)(implicit evidence$6: MonadP[F]): F[A]
Inherited from
Common
def searchArg[F[_], A](arg: String, p: Parser[A])(implicit evidence$4: MonadP[F]): NondetT[G, Parser[A]]
Inherited from
Common
def searchOpt[F[_], A](pprefs: ParserPrefs, w: OptWord, p: Parser[A])(implicit evidence$3: MonadP[F]): NondetT[G, Parser[A]]
Inherited from
Common
def searchParser[F[_], A](f: NaturalTransformation[[A] =>> Opt[A], [_] =>> NondetT[F, _$17]], p: Parser[A])(implicit evidence$2: Monad[F]): NondetT[F, Parser[A]]
Inherited from
Common
def showOption(name: OptName): String
Inherited from
Common
def simplify[A](as: OptTree[A]): OptTree[A]
Inherited from
Common
def stepParser[F[_], A](pprefs: ParserPrefs, policy: ArgPolicy, arg: String, p: Parser[A])(implicit evidence$5: MonadP[F]): NondetT[G, Parser[A]]
Inherited from
Common
def treeMapParser[A, B](g: OptHelpInfo => NaturalTransformation[[A] =>> Opt[A], [_] =>> 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.

Inherited from
Common