object NilParser extends Parser[HNil] with Product with Serializable
- Alphabetic
- By Inheritance
- NilParser
- Serializable
- Serializable
- Product
- Equals
- Parser
- ParserMethods
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def ::[A](argument: Argument[A]): ConsParser[A, HNil, HNil]
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
args: Nil.type
Arguments this parser accepts.
Arguments this parser accepts.
Used to generate help / usage messages.
- Definition Classes
- NilParser → ParserMethods
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
complete(args: Seq[String], index: Int, completer: Completer[HNil], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): List[CompletionItem]
- Definition Classes
- ParserMethods
-
def
defaultIgnoreUnrecognized: Boolean
- Definition Classes
- ParserMethods
-
def
defaultNameFormatter: Formatter[Name]
- Definition Classes
- ParserMethods
-
def
defaultStopAtFirstUnrecognized: Boolean
- Definition Classes
- ParserMethods
-
final
def
detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): Either[Error, (HNil, RemainingArgs)]
- Definition Classes
- ParserMethods
-
final
def
detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean): Either[Error, (HNil, RemainingArgs)]
- Definition Classes
- ParserMethods
-
final
def
detailedParse(args: Seq[String]): Either[Error, (HNil, RemainingArgs)]
Keeps the remaining args before and after a possible -- separated
Keeps the remaining args before and after a possible -- separated
- Definition Classes
- ParserMethods
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
get(d: D, formatter: Formatter[Name]): Right[Error, HNil]
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
- NilParser → ParserMethods
-
final
def
get(d: D): Either[Error, HNil]
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
- ParserMethods
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
ignoreUnrecognized: Aux[HNil, D]
- Definition Classes
- Parser
-
def
init: D
Initial value used to accumulate parsed arguments.
Initial value used to accumulate parsed arguments.
- Definition Classes
- NilParser → ParserMethods
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
map[U](f: (HNil) ⇒ U): Aux[U, D]
- Definition Classes
- Parser
-
def
nameFormatter(f: Formatter[Name]): Aux[HNil, 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, (HNil, Seq[String])]
- Definition Classes
- ParserMethods
-
final
def
scan(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): (Either[(Error, Either[D, HNil]), (HNil, RemainingArgs)], List[Parser.Step])
- Definition Classes
- ParserMethods
-
def
step(args: List[String], index: Int, d: HNil, formatter: Formatter[Name]): Right[(Error, Arg, List[String]), None.type]
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
- NilParser → ParserMethods
-
def
step(args: List[String], index: Int, d: D): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]
- Definition Classes
- ParserMethods
-
def
stopAtFirstUnrecognized: Aux[HNil, D]
- Definition Classes
- Parser
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withDefaultOrigin(origin: String): Aux[HNil, D]
-
final
def
withFullHelp: Parser[WithFullHelp[HNil]]
- Definition Classes
- Parser
-
final
def
withHelp: Parser[WithHelp[HNil]]
Creates a Parser accepting help / usage arguments, out of this one.