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]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsParser
  2. Serializable
  3. Product
  4. Equals
  5. Parser
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConsParser(arg: Arg, argParser: ArgParser[H], default: () => Option[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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val arg: Arg
  5. val argParser: ArgParser[H]
  6. val args: Seq[Arg]

    Arguments this parser accepts.

    Arguments this parser accepts.

    Used to generate help / usage messages.

    Definition Classes
    ConsParser → Parser
  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() @HotSpotIntrinsicCandidate()
  10. val default: () => Option[H]
  11. def defaultNameFormatter: Formatter[Name]
    Definition Classes
    Parser
  12. def defaultStopAtFirstUnrecognized: Boolean
    Definition Classes
    Parser
  13. final def detailedParse(args: Seq[String], stopAtFirstUnrecognized: Boolean): Either[Error, (::[H, T], RemainingArgs)]
    Definition Classes
    Parser
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(obj: Any): Boolean
    Definition Classes
    ConsParser → Equals → AnyRef → Any
  17. 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 → Parser
  18. 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
    Parser
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    ConsParser → AnyRef → Any
  21. def init: D

    Initial value used to accumulate parsed arguments.

    Initial value used to accumulate parsed arguments.

    Definition Classes
    ConsParser → Parser
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def map[U](f: (::[H, T]) => U): Aux[U, D]
    Definition Classes
    Parser
  24. def mapHead[I](f: (H) => I): Aux[::[I, T], D]
  25. def nameFormatter(f: Formatter[Name]): Parser[::[H, T]]
    Definition Classes
    Parser
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def parse(args: Seq[String]): Either[Error, (::[H, T], Seq[String])]
    Definition Classes
    Parser
  30. def productArity: Int
    Definition Classes
    ConsParser → Product
  31. def productElement(n: Int): Any
    Definition Classes
    ConsParser → Product
  32. def productElementName(n: Int): String
    Definition Classes
    ConsParser → Product
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. def productIterator: Iterator[Any]
    Definition Classes
    Product
  35. def productPrefix: String
    Definition Classes
    ConsParser → Product
  36. def step(args: List[String], d: ::[Option[H], (tail)#D], nameFormatter: Formatter[Name]): Either[(Error, List[String]), 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
    ConsParser → Parser
  37. final def step(args: List[String], d: D): Either[(Error, List[String]), 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
    Parser
  38. def stopAtFirstUnrecognized: Parser[::[H, T]]
    Definition Classes
    Parser
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. val tail: Aux[T, DT]
  41. def toString(): String
    Definition Classes
    ConsParser → AnyRef → Any
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. def withArg(arg: Arg): ConsParser[H, T, DT]
  46. def withArgParser(argParser: ArgParser[H]): ConsParser[H, T, DT]
  47. def withDefault(default: () => Option[H]): ConsParser[H, T, DT]
  48. 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
  49. def withTail(tail: Aux[T, DT]): ConsParser[H, T, DT]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Product

Inherited from Equals

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

Inherited from AnyRef

Inherited from Any

Ungrouped