caseapp.core.parser

RecursiveConsParser

final case class RecursiveConsParser[H, HD, T <: HList, TD <: HList](headParser: Aux[H, HD], tailParser: Aux[T, TD]) extends Parser[::[H, T]] with Product with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RecursiveConsParser
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Parser
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RecursiveConsParser(headParser: Aux[H, HD], tailParser: Aux[T, TD])

Type Members

  1. type D = ::[HD, TD]

    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
    RecursiveConsParserParser

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val args: Seq[Arg]

    Arguments this parser accepts.

    Arguments this parser accepts.

    Used to generate help / usage messages.

    Definition Classes
    RecursiveConsParserParser
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. 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
    Parser
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. 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
    RecursiveConsParserParser
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. val headParser: Aux[H, HD]

  15. def init: D

    Initial value used to accumulate parsed arguments.

    Initial value used to accumulate parsed arguments.

    Definition Classes
    RecursiveConsParserParser
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final def map[U](f: (::[H, T]) ⇒ U): Aux[U, D]

    Definition Classes
    Parser
  18. def mapHead[I](f: (H) ⇒ I): Aux[::[I, T], D]

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  22. final def parse(args: Seq[String]): Either[Error, (::[H, T], Seq[String])]

    Definition Classes
    Parser
  23. def step(args: List[String], d: D): Either[Error, Option[(D, 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
    RecursiveConsParserParser
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. val tailParser: Aux[T, TD]

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. 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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

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

Inherited from AnyRef

Inherited from Any

Ungrouped