Packages

final class ConsParser[H, T <: HList, DT <: HList] extends Parser[::[H, T]] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Parser[::[H, T]], ParserMethods[::[H, T]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsParser
  2. Serializable
  3. Product
  4. Equals
  5. Parser
  6. ParserMethods
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConsParser(argument: Argument[H], tail: Aux[T, DT])

Type Members

  1. type D = ::[Option[H], DT]

    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
    ConsParser → Parser

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ::[A](argument: Argument[A]): ConsParser[A, ::[H, T], D]
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val args: Seq[Arg]

    Arguments this parser accepts.

    Arguments this parser accepts.

    Used to generate help / usage messages.

    Definition Classes
    ConsParser → ParserMethods
  6. val argument: Argument[H]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def canEqual(obj: Any): Boolean
    Definition Classes
    ConsParser → Equals
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def complete(args: Seq[String], index: Int, completer: Completer[::[H, T]], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): List[CompletionItem]
    Definition Classes
    ParserMethods
  11. def defaultIgnoreUnrecognized: Boolean
    Definition Classes
    ParserMethods
  12. def defaultNameFormatter: Formatter[Name]
    Definition Classes
    ParserMethods
  13. def defaultStopAtFirstUnrecognized: Boolean
    Definition Classes
    ParserMethods
  14. final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): Either[Error, (::[H, T], RemainingArgs)]
    Definition Classes
    ParserMethods
  15. final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean): Either[Error, (::[H, T], RemainingArgs)]
    Definition Classes
    ParserMethods
  16. final def detailedParse(args: Seq[String]): Either[Error, (::[H, T], RemainingArgs)]

    Keeps the remaining args before and after a possible -- separated

    Keeps the remaining args before and after a possible -- separated

    Definition Classes
    ParserMethods
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(obj: Any): Boolean
    Definition Classes
    ConsParser → Equals → AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def get(d: D, nameFormatter: Formatter[Name]): Either[Error, ::[H, 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 a T 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
    ConsParser → ParserMethods
  21. final def get(d: D): Either[Error, ::[H, 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 a T 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
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    ConsParser → AnyRef → Any
  24. def ignoreUnrecognized: Aux[::[H, T], D]
    Definition Classes
    Parser
  25. def init: D

    Initial value used to accumulate parsed arguments.

    Initial value used to accumulate parsed arguments.

    Definition Classes
    ConsParser → ParserMethods
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def map[U](f: (::[H, T]) => U): Aux[U, D]
    Definition Classes
    Parser
  28. def mapHead[I](f: (H) => I): Aux[::[I, T], D]
  29. def nameFormatter(f: Formatter[Name]): Aux[::[H, T], D]
    Definition Classes
    Parser
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def parse(args: Seq[String]): Either[Error, (::[H, T], Seq[String])]
    Definition Classes
    ParserMethods
  34. def productArity: Int
    Definition Classes
    ConsParser → Product
  35. def productElement(n: Int): Any
    Definition Classes
    ConsParser → Product
  36. def productElementName(n: Int): String
    Definition Classes
    ConsParser → Product
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. def productIterator: Iterator[Any]
    Definition Classes
    Product
  39. def productPrefix: String
    Definition Classes
    ConsParser → Product
  40. final def scan(args: Seq[String], stopAtFirstUnrecognized: Boolean, ignoreUnrecognized: Boolean): (Either[(Error, Either[D, ::[H, T]]), (::[H, T], RemainingArgs)], List[Parser.Step])
    Definition Classes
    ParserMethods
  41. def step(args: List[String], index: Int, d: ::[Option[H], (tail)#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 value bar, so two elements from args - it can also be only one element in case of a flag), if possible. If you want to fully process a sequence of arguments, see parse or detailedParse.

    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
    ConsParser → ParserMethods
  42. def step(args: List[String], index: Int, d: D): Either[(Error, Arg, List[String]), Option[(D, Arg, List[String])]]
    Definition Classes
    ParserMethods
  43. def stopAtFirstUnrecognized: Aux[::[H, T], D]
    Definition Classes
    Parser
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. val tail: Aux[T, DT]
  46. def toString(): String
    Definition Classes
    ConsParser → AnyRef → Any
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. def withArgument(argument: Argument[H]): ConsParser[H, T, DT]
  51. def withDefaultOrigin(origin: String): Aux[::[H, T], D]
    Definition Classes
    ConsParser → Parser
  52. final def withFullHelp: Parser[WithFullHelp[::[H, T]]]
    Definition Classes
    Parser
  53. final def withHelp: Parser[WithHelp[::[H, T]]]

    Creates a Parser accepting help / usage arguments, out of this one.

    Creates a Parser accepting help / usage arguments, out of this one.

    Definition Classes
    Parser
  54. def withTail(tail: Aux[T, DT]): ConsParser[H, T, DT]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Parser[::[H, T]]

Inherited from ParserMethods[::[H, T]]

Inherited from AnyRef

Inherited from Any

Ungrouped