zio-cli
API
Generated with
zio-cli/zio.cli/Options

Options

zio.cli.Options
See theOptions companion object
sealed trait Options[+A]

A Flag[A] models a command-line flag that produces a value of type A.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Both[A, B]
object Empty
class KeyValueMap
class Map[A, B]
class OrElse[A, B]
class Single[A]
class WithDefault[A]
Show all
Self type
Options[A]

Members list

Value members

Abstract methods

def flatten: List[Options[_] & Input]
def uid: Option[String]

Concrete methods

final def ++[A1 >: A, B](that: Options[B])(implicit zippable: Zippable[A, B]): Options[zippable.Out]
def ??(that: String): Options[A]
def alias(name: String, names: String*): Options[A]
final def as[B, C, Z](f: (B, C) => Z)(implicit ev: A <:< (B, C)): Options[Z]
final def as[B, C, D, Z](f: (B, C, D) => Z)(implicit ev: A <:< (B, C, D)): Options[Z]
final def as[B, C, D, E, Z](f: (B, C, D, E) => Z)(implicit ev: A <:< (B, C, D, E)): Options[Z]
final def as[B, C, D, E, F, Z](f0: (B, C, D, E, F) => Z)(implicit ev: A <:< (B, C, D, E, F)): Options[Z]
final def as[B, C, D, E, F, G, Z](f0: (B, C, D, E, F, G) => Z)(implicit ev: A <:< (B, C, D, E, F, G)): Options[Z]
final def collect[B](message: String)(f: PartialFunction[A, B]): Options[B]
final def fold[B, C, Z](f1: B => Z, f2: C => Z)(implicit ev: A <:< Either[B, C]): Options[Z]
final def fold[B, C, D, Z](f1: B => Z, f2: C => Z, f3: D => Z)(implicit ev: A <:< Either[Either[B, C], D]): Options[Z]
final def fold[B, C, D, E, Z](f1: B => Z, f2: C => Z, f3: D => Z, f4: E => Z)(implicit ev: A <:< Either[Either[Either[B, C], D], E]): Options[Z]
final def fold[B, C, D, E, F, Z](f1: B => Z, f2: C => Z, f3: D => Z, f4: E => Z, f5: F => Z)(implicit ev: A <:< Either[Either[Either[Either[B, C], D], E], F]): Options[Z]
final def fold[B, C, D, E, F, G, Z](f1: B => Z, f2: C => Z, f3: D => Z, f4: E => Z, f5: F => Z, f6: G => Z)(implicit ev: A <:< Either[Either[Either[Either[Either[B, C], D], E], F], G]): Options[Z]
final def isBool: Boolean
final def map[B](f: A => B): Options[B]
final def mapOrFail[B](f: A => Either[ValidationError, B]): Options[B]
final def optional: Options[Option[A]]
final def orElse[A1 >: A](that: Options[A1]): Options[A1]
final def orElseEither[B](that: Options[B]): Options[Either[A, B]]
def withDefault[A1 >: A](value: A1): Options[A1]
def withPseudoName(name: String): Options[A]

Customizes the name used to print a placeholder value in help strings.

Customizes the name used to print a placeholder value in help strings.

The default is the type name of the option (for example 'text', 'integer', etc.

Attributes

final def |[A1 >: A](that: Options[A1]): Options[A1]

Inherited methods

def shortDesc: String

Attributes

Inherited from:
Parameter (hidden)

Concrete fields

lazy val tag: String
Generated with