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

Single

zio.cli.Options.Single
final case class Single[+A](name: String, aliases: Vector[String], primType: PrimType[A], description: HelpDoc, pseudoName: Option[String]) extends Options[A]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Options[A]
class Object
trait Matchable
class Any
Show all
Self type
Single[A]

Members list

Value members

Concrete methods

override def flatten: List[Options[_] & Input]

Attributes

Definition Classes
override def isValid(input: String, conf: CliConfig): IO[ValidationError, List[String]]

Attributes

Definition Classes
Input
override def modifySingle(f: SingleModifier): Options[A]

Attributes

Definition Classes
override def parse(args: List[String], conf: CliConfig): IO[ValidationError, (List[String], List[String])]

Attributes

Definition Classes
Input
override def validate(args: Map[String, List[String]], conf: CliConfig): IO[ValidationError, A]

Attributes

Definition Classes

Inherited methods

final def ++[A1 >: A, B](that: Options[B])(implicit zippable: Zippable[A, B]): Options[zippable.Out]

Attributes

Inherited from:
Options
def ??(that: String): Options[A]

Attributes

Inherited from:
Options
def alias(name: String, names: String*): Options[A]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
final def as[B, C, D, E, Z](f: (B, C, D, E) => Z)(implicit ev: A <:< (B, C, D, E)): Options[Z]

Attributes

Inherited from:
Options
final def as[B, C, D, Z](f: (B, C, D) => Z)(implicit ev: A <:< (B, C, D)): Options[Z]

Attributes

Inherited from:
Options
final def as[B, C, Z](f: (B, C) => Z)(implicit ev: A <:< (B, C)): Options[Z]

Attributes

Inherited from:
Options
final def collect[B](message: String)(f: PartialFunction[A, B]): Options[B]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
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]

Attributes

Inherited from:
Options
final def fold[B, C, Z](f1: B => Z, f2: C => Z)(implicit ev: A <:< Either[B, C]): Options[Z]

Attributes

Inherited from:
Options
final def isBool: Boolean

Attributes

Inherited from:
Options
final def map[B](f: A => B): Options[B]

Attributes

Inherited from:
Options
final def mapOrFail[B](f: A => Either[ValidationError, B]): Options[B]

Attributes

Inherited from:
Options
final def optional: Options[Option[A]]

Attributes

Inherited from:
Options
final def orElse[A1 >: A](that: Options[A1]): Options[A1]

Attributes

Inherited from:
Options
final def orElseEither[B](that: Options[B]): Options[Either[A, B]]

Attributes

Inherited from:
Options
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def withDefault[A1 >: A](value: A1): Options[A1]

Attributes

Inherited from:
Options
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

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

Attributes

Inherited from:
Options

Concrete fields

lazy override val helpDoc: HelpDoc
lazy val names: List[String]
lazy override val shortDesc: String
lazy val uid: Option[String]

Inherited fields

lazy val tag: String

Attributes

Inherited from:
Options
Generated with