oxygen-cli
API
Generated with
oxygen-cli/oxygen.cli/Params/Optional

Optional

oxygen.cli.Params.Optional
final case class Optional[A](parser: Params[A]) extends Params[Option[A]]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Params[Option[A]]
trait Parser[Option[A]]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def buildInternal(usedParams: Set[SimpleName]): Either[BuildError, (Set[SimpleName], Params[Option[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
override def optionalName: Option[Name]

Attributes

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

Attributes

Definition Classes

Inherited methods

final def &&[B](that: Params[B])(implicit zip: Zip[Option[A], B]): Params[zip.Out]

Attributes

Inherited from:
Params
final def <||[A2 >: Option[A]](that: Params[A2]): Params[A2]

Attributes

Inherited from:
Params
final def <||[A2 >: Option[A]](that: Parser[A2]): Parser[A2]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Parser
override def map[B](f: Option[A] => B): Params[B]

Attributes

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

Attributes

Definition Classes
Inherited from:
Params
final def optional: Params[Option[Option[A]]]

Attributes

Inherited from:
Params
final override def parse(values: List[ValueLike], params: List[ParamLike]): ParseResult[Option[A]]

Attributes

Definition Classes
Inherited from:
Params
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def repeated: Params[List[Option[A]]]

Attributes

Inherited from:
Params
final def repeatedNel: Params[NonEmptyList[Option[A]]]

Attributes

Inherited from:
Params
final def withDefault[A2 >: Option[A]](default: A2): Params[A2]

Attributes

Inherited from:
Params
final def withOptionalDefault[A2 >: Option[A]](default: Option[A2]): Params[A2]

Attributes

Inherited from:
Params
final def ||[A2 >: Option[A]](that: Params[A2]): Params[A2]

Attributes

Inherited from:
Params
Generated with