ReadableReader

argparse.core.ReadersApi.ReadableReader$
object ReadableReader extends Reader[Readable]

Attributes

Graph
Supertypes
trait Reader[Readable]
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

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

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

Inherited methods

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

Inherited from:
Reader

Concrete fields

override val 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