Packages

trait Reader[A] extends AnyRef

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

Annotations
@implicitNotFound()
Linear Supertypes
AnyRef, Any
Known Subclasses
BooleanReader, DoubleReader, DurationReader, FilePathReader, FiniteDurationReader, FloatReader, FsPathReader, InputStreamReader, InstantReader, JavaFileReader, JavaPathReader, LocalDateReader, LocalDateTimeReader, LocalTime, OutputStreamReader, PathReader, RangeReader, ReadableReader, RelPathReader, SubPathReader, ZonedDateTimeReader
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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.

  2. abstract def typeName: String

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def interactiveCompleter: (String) => Seq[String]

    Compute available shell completions starting with a given 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.

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def standaloneCompleter: BashCompleter

    A completer for bash.

    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.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped