final class ParserWithNameFormatter[T, D0] extends Parser[T] with Product with Serializable
- Alphabetic
- By Inheritance
- ParserWithNameFormatter
- Serializable
- Product
- Equals
- Parser
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type D = D0
Intermediate result type.
Intermediate result type.
Used during parsing, while checking the arguments one after the other.
If parsing succeeds, a
T
can be built from the D at the end of parsing.- Definition Classes
- ParserWithNameFormatter → Parser
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def args: Seq[Arg]
Arguments this parser accepts.
Arguments this parser accepts.
Used to generate help / usage messages.
- Definition Classes
- ParserWithNameFormatter → Parser
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def canEqual(obj: Any): Boolean
- Definition Classes
- ParserWithNameFormatter → Equals
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def complete(args: Seq[String], index: Int, completer: Completer[T], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): List[CompletionItem]
- Definition Classes
- Parser
- def defaultIgnoreUnrecognized: Boolean
- Definition Classes
- ParserWithNameFormatter → Parser
- def defaultNameFormatter: Formatter[Name]
- Definition Classes
- ParserWithNameFormatter → Parser
- def defaultStopAtFirstUnrecognized: Boolean
- Definition Classes
- ParserWithNameFormatter → Parser
- final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): Either[Error, (T, RemainingArgs)]
- Definition Classes
- Parser
- final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean): Either[Error, (T, RemainingArgs)]
- Definition Classes
- Parser
- final def detailedParse(args: Seq[String]): Either[Error, (T, RemainingArgs)]
Keeps the remaining args before and after a possible -- separated
Keeps the remaining args before and after a possible -- separated
- Definition Classes
- Parser
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
- Definition Classes
- ParserWithNameFormatter → Equals → AnyRef → Any
- val f: Formatter[Name]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(d: D, nameFormatter: Formatter[Name]): Either[Error, T]
Get the final result from the final intermediate value.
Get the final result from the final intermediate value.
Typically fails if some mandatory arguments were not specified, so are missing in
d
, preventing building aT
out of it.- returns
in case of success, a
T
wrapped in scala.Right; else, an error message, wrapped in caseapp.core.Error and scala.Left
- Definition Classes
- ParserWithNameFormatter → Parser
- final def get(d: D): Either[Error, T]
Get the final result from the final intermediate value.
Get the final result from the final intermediate value.
Typically fails if some mandatory arguments were not specified, so are missing in
d
, preventing building aT
out of it.- returns
in case of success, a
T
wrapped in scala.Right; else, an error message, wrapped in caseapp.core.Error and scala.Left
- Definition Classes
- Parser
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- ParserWithNameFormatter → AnyRef → Any
- def ignoreUnrecognized: Aux[T, D]
- Definition Classes
- Parser
- def init: D
Initial value used to accumulate parsed arguments.
Initial value used to accumulate parsed arguments.
- Definition Classes
- ParserWithNameFormatter → Parser
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def map[U](f: (T) => U): Aux[U, D]
- Definition Classes
- Parser
- def nameFormatter(f: Formatter[Name]): Aux[T, D]
- Definition Classes
- Parser
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def parse(args: Seq[String]): Either[Error, (T, Seq[String])]
- Definition Classes
- Parser
- def productArity: Int
- Definition Classes
- ParserWithNameFormatter → Product
- def productElement(n: Int): Any
- Definition Classes
- ParserWithNameFormatter → Product
- def productElementName(n: Int): String
- Definition Classes
- ParserWithNameFormatter → Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- ParserWithNameFormatter → Product
- final def scan(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): (Either[(Error, Either[D, T]), (T, RemainingArgs)], List[Step])
- Definition Classes
- Parser
- def step(args: List[String], index: Int, d: D, nameFormatter: Formatter[Name]): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]
Process the next argument.
Process the next argument.
If some arguments were successfully processed (third case in return below), the returned remaining argument sequence must be shorter than the passed
args
.This method doesn't fully process
args
. It tries just to parse *one* argument (typically one option--foo
and its valuebar
, so two elements fromargs
- it can also be only one element in case of a flag), if possible. If you want to fully process a sequence of arguments, seeparse
ordetailedParse
.- returns
if no argument were parsed,
Right(None)
; if an error occurred, an error message wrapped in caseapp.core.Error and scala.Left; else the next intermediate value and the remaining arguments wrapped in scala.Some and scala.Right.
- Definition Classes
- ParserWithNameFormatter → Parser
- def step(args: List[String], index: Int, d: D): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]
- Definition Classes
- Parser
- def stopAtFirstUnrecognized: Aux[T, D]
- Definition Classes
- Parser
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ParserWithNameFormatter → AnyRef → Any
- val underlying: Aux[T, D0]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withDefaultOrigin(origin: String): Aux[T, D]
- Definition Classes
- ParserWithNameFormatter → Parser
- def withF(f: Formatter[Name]): ParserWithNameFormatter[T, D0]
- final def withFullHelp: Parser[WithFullHelp[T]]
- Definition Classes
- Parser
- final def withHelp: Parser[WithHelp[T]]
Creates a Parser accepting help / usage arguments, out of this one.
- def withUnderlying(underlying: Aux[T, D0]): ParserWithNameFormatter[T, D0]