caseapp.core.parser

Parser

abstract class Parser[T] extends AnyRef

Parses arguments, resulting in a T in case of success.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Parser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Parser()

Type Members

  1. abstract type D

    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.

Abstract Value Members

  1. abstract def args: Seq[Arg]

    Arguments this parser accepts.

    Arguments this parser accepts.

    Used to generate help / usage messages.

  2. abstract 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 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

  3. abstract def init: D

    Initial value used to accumulate parsed arguments.

  4. abstract 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.

Concrete 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def detailedParse(args: Seq[String]): Either[Error, (T, RemainingArgs)]

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

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

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

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

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

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

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

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def withHelp: Parser[WithHelp[T]]

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

Inherited from AnyRef

Inherited from Any

Ungrouped