clam
API
Generated with
clam/clam.derivation/Api

Api

clam.derivation.Api
trait Api extends DerivationApi with StandardReaders with StandardCompleters

Attributes

Graph
Supertypes
trait StandardStringReaders
trait LowPrioStringReaders
trait StringReaderApi
trait ReaderApi
class Object
trait Matchable
class Any
Known subtypes
object DefaultApi.type

Members list

Concise view

Type members

Inherited classlikes

case class Command[+A](parsers: IndexedSeq[Parser[_]], instantiate: IndexedSeq[_] => A, name: String, doc: String)

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Command

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
trait Completer[A]

Attributes

Inherited from:
CompletionApi
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object booleanCompleter.type
object LocalDateReader extends StringReader[LocalDate]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[LocalDate]
class Object
trait Matchable
class Any
object LocalDateTimeReader extends StringReader[LocalDateTime]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[LocalDateTime]
class Object
trait Matchable
class Any
object LocalTime extends StringReader[LocalTime]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[LocalTime]
class Object
trait Matchable
class Any
trait Parser[+A]

A parser is responsible for defining a set of CLI parameters and implementing a way to extract a value from the corresponding arguments.

A parser is responsible for defining a set of CLI parameters and implementing a way to extract a value from the corresponding arguments.

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class RepeatedParam[A, Col]
class SingleParam[A]
class Subcommand[A]
object RangeReader extends StringReader[Range]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Range]
class Object
trait Matchable
class Any
object Reader

Attributes

Inherited from:
ReaderApi
Graph
Supertypes
class Object
trait Matchable
class Any
trait Reader[A]

Attributes

Inherited from:
ReaderApi
Graph
Supertypes
class Object
trait Matchable
class Any
case class RepeatedParam[A, Col <: (Iterable)](scalaName: String, default: Option[() => Col[A]], annot: param, doc: String, argName0: Option[String], reader0: Reader[A], completer: Completer[A], factory: Factory[A, Col[A]]) extends Parser[Col[A]]

A single CLI parameter (may be repeated) which maps to a single scala parameter.

A single CLI parameter (may be repeated) which maps to a single scala parameter.

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[Col[A]]
class Object
trait Matchable
class Any
trait ScalaParam[A]

Signature of a Scala parameter. These are used by the derivation macros to to instantiate parsers for every parameter. Note that this API should be considered experimental. In the future, this typeclass may be eliminated and the behavior folded directly into macros.

Signature of a Scala parameter. These are used by the derivation macros to to instantiate parsers for every parameter. Note that this API should be considered experimental. In the future, this typeclass may be eliminated and the behavior folded directly into macros.

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
class Object
trait Matchable
class Any
case class SingleParam[A](scalaName: String, default: Option[() => A], annot: param, doc: String, argName0: Option[String], reader0: Reader[A], completer: Completer[A]) extends Parser[A]

A single CLI parameter (may not be repeated) which maps to a single scala parameter.

A single CLI parameter (may not be repeated) which maps to a single scala parameter.

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[A]
class Object
trait Matchable
class Any
object StringReader

Attributes

Inherited from:
StringReaderApi
Graph
Supertypes
class Object
trait Matchable
class Any
trait StringReader[A]

Attributes

Inherited from:
StringReaderApi
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object LocalDateReader.type
object LocalTime.type
object RangeReader.type
object absPathReader.type
object booleanReader.type
object doubleReader.type
object durationReader.type
object floatReader.type
object instantReader.type
object jFileReader.type
object jPathReader.type
object pathReader.type
object relPathReader.type
object stringReader.type
object subPathReader.type
case class Subcommand[+A](subcommands: Map[String, Command[A]]) extends Parser[A]

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Parser[A]
class Object
trait Matchable
class Any
object Subcommand

Attributes

Inherited from:
DerivationApi
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
object absPathReader extends StringReader[Path]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Path]
class Object
trait Matchable
class Any
object booleanCompleter extends Completer[Boolean]

Attributes

Inherited from:
StandardCompleters
Graph
Supertypes
trait Completer[Boolean]
class Object
trait Matchable
class Any
object booleanReader extends StringReader[Boolean]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Boolean]
class Object
trait Matchable
class Any
object doubleReader extends StringReader[Double]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Double]
class Object
trait Matchable
class Any
object durationReader extends StringReader[Duration]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Duration]
class Object
trait Matchable
class Any
object finiteDurationReader extends StringReader[FiniteDuration]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[FiniteDuration]
class Object
trait Matchable
class Any
object floatReader extends StringReader[Float]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Float]
class Object
trait Matchable
class Any
object instantReader extends StringReader[Instant]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Instant]
class Object
trait Matchable
class Any
object jFileReader extends StringReader[File]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[File]
class Object
trait Matchable
class Any
object jPathReader extends StringReader[Path]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[Path]
class Object
trait Matchable
class Any
object pathReader extends StringReader[FilePath]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[FilePath]
class Object
trait Matchable
class Any
object relPathReader extends StringReader[RelPath]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[RelPath]
class Object
trait Matchable
class Any
object stringReader extends StringReader[String]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[String]
class Object
trait Matchable
class Any
object subPathReader extends StringReader[SubPath]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[SubPath]
class Object
trait Matchable
class Any
object zonedDateTimeReader extends StringReader[ZonedDateTime]

Attributes

Inherited from:
StandardStringReaders
Graph
Supertypes
trait StringReader[ZonedDateTime]
class Object
trait Matchable
class Any

Value members

Inherited methods

def defaultHelpMessage(term: Terminal, description: String, commandChain: Iterable[String], params: Iterable[ParamDef], subcommands: Iterable[(String, String)]): String

Generate a help message from parameters.

Generate a help message from parameters.

Overriding this allows you to customize the help message of all commands.

Attributes

Inherited from:
SupportApi
def scalaToNamedParam(scalaName: String): String

Attributes

Inherited from:
DerivationApi
def scalaToPositionalParam(scalaName: String): String

Attributes

Inherited from:
DerivationApi
def scalaToSubcommand(scalaName: String): String

Attributes

Inherited from:
DerivationApi

Givens

Inherited givens

given LocalDateReader: LocalDateReader.type

Attributes

Inherited from:
StandardStringReaders
given LocalDateTimeReader: LocalDateTimeReader.type

Attributes

Inherited from:
StandardStringReaders
given LocalTime: LocalTime.type

Attributes

Inherited from:
StandardStringReaders
given RangeReader: RangeReader.type

Attributes

Inherited from:
StandardStringReaders
given absPathCompleter: Completer[Path]

Attributes

Inherited from:
StandardCompleters
given absPathReader: absPathReader.type

Attributes

Inherited from:
StandardStringReaders
given booleanCompleter: booleanCompleter.type

Attributes

Inherited from:
StandardCompleters
given booleanReader: booleanReader.type

Attributes

Inherited from:
StandardStringReaders
given collectionReader[Elem, Col <: (Iterable)](using elementReader: StringReader[Elem], factory: Factory[Elem, Col[Elem]]): collectionReader[Elem, Col]

Attributes

Inherited from:
LowPrioStringReaders
given doubleReader: doubleReader.type

Attributes

Inherited from:
StandardStringReaders
given durationReader: durationReader.type

Attributes

Inherited from:
StandardStringReaders
given emptyCompleter[A]: emptyCompleter[A]

Attributes

Inherited from:
LowPrioCompleters
given explicitParam[A](using p: Parser[A]): ScalaParam[A]

Attributes

Inherited from:
DerivationApi
given filePathCompleter: Completer[FilePath]

Attributes

Inherited from:
StandardCompleters
given finiteDurationReader: finiteDurationReader.type

Attributes

Inherited from:
StandardStringReaders
given flagParam(using reader: Reader[Boolean], completer: Completer[Boolean]): ScalaParam[Boolean]

Attributes

Inherited from:
DerivationApi
given floatReader: floatReader.type

Attributes

Inherited from:
StandardStringReaders
given given_Reader_A[A](using r: StringReader[A]): given_Reader_A[A]

Attributes

Inherited from:
StandardReaders
given instantReader: instantReader.type

Attributes

Inherited from:
StandardStringReaders
given integralReader[N](using n: Integral[N]): integralReader[N]

Attributes

Inherited from:
StandardStringReaders
given jFileReader: jFileReader.type

Attributes

Inherited from:
StandardStringReaders
given jPathReader: jPathReader.type

Attributes

Inherited from:
StandardStringReaders
given javaFileCompleter: Completer[File]

Attributes

Inherited from:
StandardCompleters
given javaPathCompleter: Completer[Path]

Attributes

Inherited from:
StandardCompleters
given pathReader: pathReader.type

Attributes

Inherited from:
StandardStringReaders
given relPathCompleter: Completer[RelPath]

Attributes

Inherited from:
StandardCompleters
given relPathReader: relPathReader.type

Attributes

Inherited from:
StandardStringReaders
given repeatedFlagParam[Col <: (Iterable)](using reader: Reader[Boolean], completer: Completer[Boolean], factory: Factory[Boolean, Col[Boolean]]): ScalaParam[Col[Boolean]]

Attributes

Inherited from:
DerivationApi
given repeatedParam[A, Col <: (Iterable)](using reader: Reader[A], completer: Completer[A], factory: Factory[A, Col[A]]): ScalaParam[Col[A]]

Attributes

Inherited from:
DerivationApi
given simpleParam[A](using reader: Reader[A], completer: Completer[A]): ScalaParam[A]

Attributes

Inherited from:
DerivationApi
given stringReader: stringReader.type

Attributes

Inherited from:
StandardStringReaders
given subPathCompleter: Completer[SubPath]

Attributes

Inherited from:
StandardCompleters
given subPathReader: subPathReader.type

Attributes

Inherited from:
StandardStringReaders
given tupleReader[K, V](using kr: StringReader[K], vr: StringReader[V]): tupleReader[K, V]

Attributes

Inherited from:
StandardStringReaders
given zonedDateTimeReader: zonedDateTimeReader.type

Attributes

Inherited from:
StandardStringReaders
Generated with