mainargs
API
Generated with
mainargs/mainargs/TokensReader/Simple

Simple

mainargs.TokensReader.Simple
trait Simple[T] extends ShortNamed[T]

A TokensReader for a single CLI parameter that takes a value e.g. --foo bar

Attributes

Graph
Supertypes
trait ShortNamed[T]
trait Terminal[T]
trait TokensReader[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
object BooleanRead.type
object ByteRead.type
object DoubleRead.type
object FloatRead.type
object IntRead.type
object LongRead.type
class MapRead[K, V]
class OptionRead[T]
class SeqRead[C, T]
object ShortRead.type
object StringRead.type
Show all

Members list

Value members

Abstract methods

def read(strs: Seq[String]): Either[String, T]
Implicitly added by LeftoverRead
def read(strs: Seq[String]): Either[String, 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
Implicitly added by LeftoverRead

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

Concrete methods

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

def alwaysRepeatable: Boolean

Whether is CLI param is repeatable

Whether is CLI param is repeatable

Attributes

def isClass: Boolean
Implicitly added by OptionRead
def isConstant: Boolean
Implicitly added by OptionRead
def isFlag: Boolean
Implicitly added by OptionRead
def isLeftover: Boolean
Implicitly added by OptionRead
def isSimple: Boolean
Implicitly added by OptionRead
override def isSimple: Boolean

Attributes

Definition Classes

Inherited methods

def isClass: Boolean
Implicitly added by LeftoverRead

Attributes

Inherited from:
TokensReader
def isClass: Boolean

Attributes

Inherited from:
TokensReader
def isConstant: Boolean
Implicitly added by LeftoverRead

Attributes

Inherited from:
TokensReader
def isConstant: Boolean

Attributes

Inherited from:
TokensReader
def isFlag: Boolean
Implicitly added by LeftoverRead

Attributes

Inherited from:
TokensReader
def isFlag: Boolean

Attributes

Inherited from:
TokensReader
def isLeftover: Boolean

Attributes

Inherited from:
TokensReader
def isSimple: Boolean
Implicitly added by LeftoverRead

Attributes

Inherited from:
TokensReader
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 from:
ShortNamed
Generated with