mainargs
API
Generated with
mainargs/mainargs/TokensReader/OptionRead

OptionRead

mainargs.TokensReader.OptionRead
class OptionRead[T] extends Simple[Option[T]]

Attributes

Graph
Supertypes
trait Simple[Option[T]]
trait ShortNamed[Option[T]]
trait Terminal[Option[T]]
trait TokensReader[Option[T]]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def allowEmpty: Boolean

Whether this CLI param can be no passed from the CLI, even if a default value is not specified. In that case, read receives an empty Seq

Whether this CLI param can be no passed from the CLI, even if a default value is not specified. In that case, read receives an empty Seq

Attributes

Definition Classes
def read(strs: Seq[String]): Either[String, Option[T]]

Converts the given input tokens to a T or an error String. The input is a Seq because input tokens can be passed more than once, e.g. --foo bar --foo qux will result in read being passed ["foo", "qux"]

Converts the given input tokens to a T or an error String. The input is a Seq because input tokens can be passed more than once, e.g. --foo bar --foo qux will result in read being passed ["foo", "qux"]

Attributes

def shortName: String

The label that shows up in the CLI help message, e.g. the bar in --foo <bar>

The label that shows up in the CLI help message, e.g. the bar in --foo <bar>

Attributes

Inherited methods

def alwaysRepeatable: Boolean

Whether is CLI param is repeatable

Whether is CLI param is repeatable

Attributes

Inherited from:
Simple
def isClass: Boolean

Attributes

Inherited from:
TokensReader
def isConstant: Boolean

Attributes

Inherited from:
TokensReader
def isFlag: Boolean

Attributes

Inherited from:
TokensReader
def isLeftover: Boolean

Attributes

Inherited from:
TokensReader
override def isSimple: Boolean

Attributes

Definition Classes
Inherited from:
Simple
Generated with