Params

oxygen.cli.Params
See theParams companion object
sealed trait Params[+A] extends Parser[A]

Attributes

Companion
object
Experimental
true
Graph
Supertypes
trait Parser[A]
class Object
trait Matchable
class Any
Known subtypes
class And[A, B, O]
class Const[A]
class IfPresent[A]
object Ignored
class Mapped[A, B]
class MappedOrFail[A, B]
class Optional[A]
class Or[A]
class ParamWithValues[A]
class Raw
class Repeated[A]
class RepeatedNel[A]
class WithDefault[A]
Show all

Members list

Value members

Abstract methods

override def buildInternal(usedParams: Set[SimpleName]): Either[BuildError, (Set[SimpleName], Params[A])]

This should do 2 things:

This should do 2 things:

  1. Fail if there are duplicate param names
  2. Convert Defaultable.Auto into Defaultable.Some/Defaultable.None based on start of long name

Attributes

Definition Classes
override def helpMessage: ParamMessage

Attributes

Definition Classes
def parseParams(params: List[ParamLike]): ParseResult[A]

Concrete methods

final def &&[B](that: Params[B])(implicit zip: Zip[A, B]): Params[zip.Out]
final def <||[A2 >: A](that: Params[A2]): Params[A2]
final def <||>[B](that: Params[B]): Params[Either[A, B]]
override def map[B](f: A => B): Params[B]

Attributes

Definition Classes
override def mapOrFail[B](f: A => Either[String, B]): Params[B]

Attributes

Definition Classes
final def optional: Params[Option[A]]
final override def parse(values: List[ValueLike], params: List[ParamLike]): ParseResult[A]

Attributes

Definition Classes
final def repeated: Params[List[A]]
final def repeatedNel: Params[NonEmptyList[A]]
final def withDefault[A2 >: A](default: A2): Params[A2]
final def withOptionalDefault[A2 >: A](default: Option[A2]): Params[A2]
final def ||[A2 >: A](that: Params[A2]): Params[A2]

Inherited methods

final def <||[A2 >: A](that: Parser[A2]): Parser[A2]

Attributes

Inherited from:
Parser
final def <||>[B](that: Parser[B]): Parser[Either[A, B]]

Attributes

Inherited from:
Parser
final def ^>>[B](that: Parser[B])(implicit zip: Zip[A, B]): Parser[zip.Out]

Attributes

Inherited from:
Parser
final def bracketed(name: LongName): Values[A]

Attributes

Inherited from:
Parser
final def build: Either[BuildError, Parser[Either[HelpType, A]]]

Attributes

Inherited from:
Parser

Inherited and Abstract methods

def optionalName: Option[Name]

Attributes

Inherited from:
Parser