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

Args

zio.cli.Args
See theArgs companion trait
object Args

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Args.type

Members list

Type members

Classlikes

final case class Both[+A, +B](head: Args[A], tail: Args[B]) extends Args[(A, B)]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Args[(A, B)]
class Object
trait Matchable
class Any
Show all
case object Empty extends Args[Unit]

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Args[Unit]
class Object
trait Matchable
class Any
Show all
Self type
Empty.type
final case class Map[A, B](value: Args[A], f: A => Either[HelpDoc, B]) extends Args[B]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Args[B]
class Object
trait Matchable
class Any
Show all
final case class Single[+A](pseudoName: Option[String], primType: PrimType[A], description: HelpDoc) extends Args[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Args[A]
class Object
trait Matchable
class Any
Show all
final case class Variadic[+A](value: Args[A], min: Option[Int], max: Option[Int]) extends Args[List[A]]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Args[List[A]]
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def bool(name: String): Args[Boolean]

Creates a boolean argument with a custom argument name

Creates a boolean argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Boolean argument

def decimal(name: String): Args[BigDecimal]

Creates a decimal argument with a custom argument name

Creates a decimal argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Decimal argument

def duration(name: String): Args[Duration]

Creates a duration argument with a custom argument name

Creates a duration argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Duration argument

def enumeration[A](name: String)(cases: (String, A)*): Args[A]

Creates a enumeration argument with a custom argument name

Creates a enumeration argument with a custom argument name

Value parameters

cases

Enum cases

name

Argument name

Attributes

Returns

Enumeration argument

def enumeration[A](cases: (String, A)*): Args[A]

Creates a enumeration argument with 'choice' as argument name

Creates a enumeration argument with 'choice' as argument name

Value parameters

cases

Enum cases

Attributes

Returns

Enumeration argument

def instant(name: String): Args[Instant]

Creates a instant argument with a custom argument name

Creates a instant argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Instant argument

def integer(name: String): Args[BigInt]

Creates an integer argument with a custom argument name

Creates an integer argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Integer argument

def localDate(name: String): Args[LocalDate]

Creates a localDate argument with a custom argument name

Creates a localDate argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

LocalDate argument

def localDateTime(name: String): Args[LocalDateTime]

Creates a localDateTime argument with a custom argument name

Creates a localDateTime argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

LocalDateTime argument

def localTime(name: String): Args[LocalTime]

Creates a localTime argument with a custom argument name

Creates a localTime argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

LocalTime argument

def monthDay(name: String): Args[MonthDay]

Creates a monthDay argument with a custom argument name

Creates a monthDay argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

MonthDay argument

def offsetDateTime(name: String): Args[OffsetDateTime]

Creates a offsetDateTime argument with a custom argument name

Creates a offsetDateTime argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

OffsetDateTime argument

def offsetTime(name: String): Args[OffsetTime]

Creates a offsetTime argument with a custom argument name

Creates a offsetTime argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

OffsetTime argument

def period(name: String): Args[Period]

Creates a period argument with a custom argument name

Creates a period argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Period argument

def text(name: String): Args[String]

Creates a text argument with a custom argument name

Creates a text argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Text argument

def year(name: String): Args[Year]

Creates a year argument with a custom argument name

Creates a year argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Year argument

def yearMonth(name: String): Args[YearMonth]

Creates a yearMonth argument with a custom argument name

Creates a yearMonth argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

YearMonth argument

def zoneId(name: String): Args[ZoneId]

Creates a zoneId argument with a custom argument name

Creates a zoneId argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

ZoneId argument

def zoneOffset(name: String): Args[ZoneOffset]

Creates a zoneOffset argument with a custom argument name

Creates a zoneOffset argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

ZoneOffset argument

def zonedDateTime(name: String): Args[ZonedDateTime]

Creates a zonedDateTime argument with a custom argument name

Creates a zonedDateTime argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

ZonedDateTime argument

Inherited methods

def directory(exists: Exists): Args[Path]

Creates a directory argument with 'directory' as argument name

Creates a directory argument with 'directory' as argument name

Value parameters

exists

Yes if path is expected to exists, No otherwise or Either is both are acceptable.

Attributes

Returns

Directory argument

Inherited from:
ArgsPlatformSpecific (hidden)
def directory(name: String, exists: Exists): Args[Path]

Creates a directory argument with a custom argument name

Creates a directory argument with a custom argument name

Value parameters

exists

Yes if path is expected to exists, No otherwise or Either is both are acceptable.

name

Argument name

Attributes

Returns

Directory argument

Inherited from:
ArgsPlatformSpecific (hidden)
def file(exists: Exists): Args[Path]

Creates a file argument with 'file' as argument name

Creates a file argument with 'file' as argument name

Value parameters

exists

Yes if path is expected to exists, No otherwise or Either is both are acceptable.

Attributes

Returns

File argument

Inherited from:
ArgsPlatformSpecific (hidden)
def file(name: String, exists: Exists): Args[Path]

Creates a file argument with a custom argument name

Creates a file argument with a custom argument name

Value parameters

exists

Yes if path is expected to exists, No otherwise or Either is both are acceptable.

name

Argument name

Attributes

Returns

File argument

Inherited from:
ArgsPlatformSpecific (hidden)
def path(name: String): Args[Path]

Creates a path argument with a custom argument name

Creates a path argument with a custom argument name

Value parameters

name

Argument name

Attributes

Returns

Path argument

Inherited from:
ArgsPlatformSpecific (hidden)

Concrete fields

val bool: Args[Boolean]

Creates a boolean argument with boolean as argument name

Creates a boolean argument with boolean as argument name

Attributes

val decimal: Args[BigDecimal]

Creates a decimal argument with 'decimal' as argument name

Creates a decimal argument with 'decimal' as argument name

Attributes

val duration: Args[Duration]

Creates a duration argument with 'duration' as argument name

Creates a duration argument with 'duration' as argument name

Attributes

val instant: Args[Instant]

Creates a instant argument with 'instant' as argument name

Creates a instant argument with 'instant' as argument name

Attributes

val integer: Args[BigInt]

Creates an integer argument with 'integer' as argument name

Creates an integer argument with 'integer' as argument name

Attributes

val localDateTime: Args[LocalDateTime]

Creates a localDateTime argument with 'date-time' as argument name

Creates a localDateTime argument with 'date-time' as argument name

Attributes

val localTime: Args[LocalTime]

Creates a localTime argument with 'local-time' as argument name

Creates a localTime argument with 'local-time' as argument name

Attributes

val monthDay: Args[MonthDay]

Creates a monthDay argument with 'month-day' as argument name

Creates a monthDay argument with 'month-day' as argument name

Attributes

val none: Args[Unit]

Creates a empty argument

Creates a empty argument

Attributes

val offsetDateTime: Args[OffsetDateTime]

Creates a offsetDateTime argument with 'offset-date-time' as argument name

Creates a offsetDateTime argument with 'offset-date-time' as argument name

Attributes

val offsetTime: Args[OffsetTime]

Creates a offsetTime argument with 'offset-time' as argument name

Creates a offsetTime argument with 'offset-time' as argument name

Attributes

val period: Args[Period]

Creates a period argument with 'period' as argument name

Creates a period argument with 'period' as argument name

Attributes

val text: Args[String]

Creates a text argument with 'text' as argument name

Creates a text argument with 'text' as argument name

Attributes

val year: Args[Year]

Creates a year argument with 'year' as argument name

Creates a year argument with 'year' as argument name

Attributes

val yearMonth: Args[YearMonth]

Creates a yearMonth argument with 'year-month' as argument name

Creates a yearMonth argument with 'year-month' as argument name

Attributes

val zoneId: Args[ZoneId]

Creates a zoneId argument with 'zone-id' as argument name

Creates a zoneId argument with 'zone-id' as argument name

Attributes

val zoneOffset: Args[ZoneOffset]

Creates a zoneOffset argument with 'zone-offset' as argument name

Creates a zoneOffset argument with 'zone-offset' as argument name

Attributes

val zonedDateTime: Args[ZonedDateTime]

Creates a zonedDateTime argument with 'zoned-date-time' as argument name

Creates a zonedDateTime argument with 'zoned-date-time' as argument name

Attributes

Inherited fields

val directory: Args[Path]

Creates a directory argument with 'directory' as argument name, and exists being 'Either'

Creates a directory argument with 'directory' as argument name, and exists being 'Either'

Attributes

Inherited from:
ArgsPlatformSpecific (hidden)
val file: Args[Path]

Creates a file argument with 'file' as argument name, and exists being 'Either'

Creates a file argument with 'file' as argument name, and exists being 'Either'

Attributes

Inherited from:
ArgsPlatformSpecific (hidden)
val path: Args[Path]

Creates a path argument with 'path' as argument name

Creates a path argument with 'path' as argument name

Attributes

Inherited from:
ArgsPlatformSpecific (hidden)
Generated with