argparse
API
Generated with
argparse/argparse.core/TypesApi/Reader

Reader

argparse.core.TypesApi.Reader
See theReader companion object
trait Reader[A]

A typeclass that defines how to convert a string from a single command line argument to a given type.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BooleanReader.type
object DoubleReader.type
object DurationReader.type
object FloatReader.type
trait FsPathReader[A]
object FilePathReader.type
object JavaFileReader.type
object JavaPathReader.type
object PathReader.type
object RelPathReader.type
object SubPathReader.type
object InputStreamReader.type
object InstantReader.type
object LocalDateReader.type
object LocalTime.type
object OutputStreamReader.type
object RangeReader.type
object ReadableReader.type

Members list

Concise view

Value members

Abstract methods

def read(a: String): Result[A]

Either convert the string to A or return a failure message.

Either convert the string to A or return a failure message.

Do not throw from a reader, as it will cause the argument parser to crash, leading to a horrible user experience.

Attributes

def typeName: String

The human-friendly name of this reader's argument type.

The human-friendly name of this reader's argument type.

Attributes

Concrete methods

def interactiveCompleter: String => Seq[String]

Compute available shell completions starting with a given string. This is used by interactive bash completion, where the user program is responsible for generating completions.

Compute available shell completions starting with a given string. This is used by interactive bash completion, where the user program is responsible for generating completions.

Attributes

def standaloneCompleter: BashCompleter

A completer for bash. This is used by standalone bash completion, where a bash script generates completion, without the involvement of the the user program.

A completer for bash. This is used by standalone bash completion, where a bash script generates completion, without the involvement of the the user program.

If your program is running on the JVM, the startup time is considerable and hence standalone completion should be preferred to interactive completion for a snappy user experience.

Attributes

Generated with