FlagArgParser

caseapp.core.argparser.FlagArgParser

See theFlagArgParser companion object

case class FlagArgParser[T](description: String, parse: (Option[String], Int, Int) => Either[Error, T]) extends ArgParser[T]

Attributes

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class ArgParser[T]

class Object

trait Matchable

class Any
Show all

Parses a value.

value must be consumed. Corresponds to cases like --foo=bar.

Returns: in case of success, a T, wrapped in scala.Right; else, and error message, wrapped in caseapp.core.Error and scala.Left

Called when the corresponding argument was specified with no value.

Can happen if the option was enabled as very last argument, like --bar in --foo 1 other --bar.

Returns: a T wrapped in scala.Right in case of success, or an error message wrapped in caseapp.core.Error and scala.Left else
Definition Classes: ArgParser

Whether the parsed value corresponds to a flag.

Prevents telling corresponding arguments expect a value in help messages.

Parses a value.

Unlike apply above, value may or may not be consumed. Corresponds to cases like --foo bar.

Use of value or not must be returned via the caseapp.core.argparser.Consumed value.

Returns: in case of success, whether value was consumed and a T, wrapped in scala.Right; else, and error message, wrapped in caseapp.core.Error and scala.Left
Definition Classes: ArgParser

In this article

Generated with