RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.commands/FromCommand

FromCommand

com.ossuminc.riddl.commands.FromCommand

See theFromCommand companion object

class FromCommand(using io: PlatformContext) extends Command[Options]

Attributes

Companion: object
Source: FromCommand.scala
Graph
Supertypes: trait Command[Options]

class Object

trait Matchable

class Any

Members list

Value members

Concrete methods

Provide a typesafe/Config reader for the commands options.

Provide a typesafe/Config reader for the commands options. This reader should read an object having the same name as the command. The fields of that object must correspond to the fields of the OPT type.

Attributes

Returns: A pureconfig.ConfigReader[OPT] that knows how to read OPT
Definition Classes: Command
Source: FromCommand.scala

Provide an scopt OParser for the commands options type, OPT

Attributes

Returns: A pair: the OParser and the default values for OPT
Definition Classes: Command
Source: FromCommand.scala

Attributes

Definition Classes: Command
Source: FromCommand.scala

Attributes

Definition Classes: Command
Source: FromCommand.scala

Execute the command given the options.

Execute the command given the options. Error should be returned as Left(messages) and not directly logged. The log is for verbose or debug output

Value parameters

options: The command specific options

Attributes

Returns: Either a set of Messages on error or a Unit on success
Definition Classes: Command
Source: FromCommand.scala

Inherited methods

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

Inherited fields

Attributes

Inherited from:: Command
Source: Command.scala

Attributes

Inherited from:: Command
Source: Command.scala

In this article

Generated with