dfhdl
API
Generated with
dfhdl/dfhdl/dfhdl.app/ParsedCommandLine/HelpMode/backend

backend

dfhdl.app.ParsedCommandLine.HelpMode.backend
case object backend extends HelpMode

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
class HelpMode
trait Serializable
trait Product
trait Equals
class Subcommand
class ScallopConf
class ScallopConfBase
trait ScallopConfValidations
class Object
trait Matchable
class Any
Show all
Self type
backend.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

Inherited and Abstract types

type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Inherited methods

def addSubcommand(conf: Subcommand): Unit

Add subcommand to this config

Add subcommand to this config

Attributes

Inherited from:
ScallopConfBase
def addValidation(fn: => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfBase
def allDefinedOrUndefined(list: ScallopOption[_]*): Unit

Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).

Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).

Value parameters

list

list of options

Attributes

Inherited from:
ScallopConfBase
def appendDefaultToDescription: Boolean

If set to true, scallop would append auto-generated text about default option value to option descriptions.

If set to true, scallop would append auto-generated text about default option value to option descriptions.

Attributes

Inherited from:
ScallopConfBase
def appendDefaultToDescription_=(v: Boolean): Unit

If set to true, scallop would append auto-generated text about default option value to option descriptions.

If set to true, scallop would append auto-generated text about default option value to option descriptions.

Attributes

Inherited from:
ScallopConfBase
def assertVerified(): Unit

Checks that this Conf object is verified. If it is not, throws an exception.

Checks that this Conf object is verified. If it is not, throws an exception.

Attributes

Inherited from:
ScallopConfBase
def choice(choices: Seq[String], name: String, short: Char, descr: String, default: => Option[String], required: Boolean, argName: String, hidden: Boolean, noshort: Boolean, group: ScallopOptionGroup): ScallopOption[String]

Add a new choice option definition to this config.

Add a new choice option definition to this config.

This option takes a single string argument and restricts values to a list of possible choices.

Value parameters

argName

The name for this option argument, as it will appear in help. Defaults to "arg".

choices

List of possible argument values.

conv

The converter for this option. Usually found implicitly.

default

Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).

descr

Description for this option, for help description.

group

Option group to add this option to.

hidden

If set to true, then this option will be hidden from generated help output.

name

Name for new option, used as long option name in parsing, and for option identification.

noshort

If set to true, then this option does not have any short name.

required

Is this option required? Defaults to false.

short

Overload the char that will be used as short option name. Defaults to first character of the name.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def codependent(list: ScallopOptionBase*): Unit

Add a check that either all or none of the provided options have values supplied in arguments.

Add a check that either all or none of the provided options have values supplied in arguments.

Value parameters

list

list of codependent options

Attributes

Inherited from:
ScallopConfBase
def conflicts(opt: ScallopOptionBase, list: List[ScallopOptionBase]): Unit

Add a check that none of the options in the list were supplied if opt was supplied.

Add a check that none of the options in the list were supplied if opt was supplied.

Value parameters

list

list of dependencies (all will need to be absent)

opt

option that conflicts with all of options in list

Attributes

Inherited from:
ScallopConfBase
def dependsOnAll(opt: ScallopOptionBase, list: List[ScallopOptionBase]): Unit

Add a check that all of the options in the list were also supplied if opt was supplied.

Add a check that all of the options in the list were also supplied if opt was supplied.

Value parameters

list

list of dependencies (all will need to be present)

opt

option that depends on all of options in list

Attributes

Inherited from:
ScallopConfBase
def dependsOnAny(opt: ScallopOptionBase, list: List[ScallopOptionBase]): Unit

Add a check that at least one of the options in the list was supplied if opt was supplied.

Add a check that at least one of the options in the list was supplied if opt was supplied.

Value parameters

list

list of dependencies (at least one will need to be present)

opt

option, that depends on any of options in list

Attributes

Inherited from:
ScallopConfBase
def descr(d: String): Unit

Short description for this subcommand. Used if parent command has shortSubcommandsHelp enabled.

Short description for this subcommand. Used if parent command has shortSubcommandsHelp enabled.

Attributes

Inherited from:
Subcommand
def filteredSummary(blurred: Set[String]): String

Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)

Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)

Value parameters

blurred

names of the options that should be hidden.

Attributes

Returns

a list of all options in the builder

Inherited from:
ScallopConfBase
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def getFullHelpString(): String

Get full generated help contents (with version, banner, option usage and footer) as a string.

Get full generated help contents (with version, banner, option usage and footer) as a string.

Attributes

Inherited from:
ScallopConfBase
def getHelpString(): String

Get generated help contents as a string.

Get generated help contents as a string.

Attributes

Inherited from:
ScallopConfBase
def getVersionString(): Option[String]

Get version string.

Get version string.

Attributes

Inherited from:
ScallopConfBase
def group(header: String): ScallopOptionGroup

Create and return a new option group

Create and return a new option group

Attributes

Inherited from:
ScallopConfBase
def guessOptionName: Boolean

If true, scallop would try to guess missing option names from the names of their fields.

If true, scallop would try to guess missing option names from the names of their fields.

Attributes

Inherited from:
ScallopConf
def guessOptionName_=(v: Boolean): Unit

If set to true, scallop would try to guess missing option names from the names of their fields.

If set to true, scallop would try to guess missing option names from the names of their fields.

Attributes

Inherited from:
ScallopConf
def helpFormatter: ScallopHelpFormatter

Get current custom help formatter.

Get current custom help formatter.

Attributes

Inherited from:
ScallopConfBase
def helpFormatter_=(formatter: ScallopHelpFormatter): Unit

Set custom help formatter.

Set custom help formatter.

Attributes

Inherited from:
ScallopConfBase
def helpWidth(w: Int): Unit

Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.

Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.

Attributes

Inherited from:
ScallopConfBase
def mainOptions: Seq[CliOption]

Options, that are to be printed first in the help printout

Options, that are to be printed first in the help printout

Attributes

Inherited from:
ScallopConfBase
def mutuallyExclusive(list: ScallopOptionBase*): Unit

Add a check that only one or zero of the provided options have values supplied in arguments.

Add a check that only one or zero of the provided options have values supplied in arguments.

Value parameters

list

list of mutually exclusive options

Attributes

Inherited from:
ScallopConfBase
def noshort: Boolean

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

Attributes

Inherited from:
ScallopConfBase
def noshort_=(v: Boolean): Unit

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

Attributes

Inherited from:
ScallopConfBase
def number(name: String, descr: String, validate: Long => Boolean, required: Boolean, default: => Option[Long], hidden: Boolean, group: ScallopOptionGroup)(implicit conv: ValueConverter[Long]): ScallopOption[Long]

Add new number argument definition to this config and get a holder for it's value.

Add new number argument definition to this config and get a holder for it's value.

Parses arguments like -1 or -3 (like GNU tail, for example).

Value parameters

conv

The converter for this option. Usually found implicitly.

default

If this argument is not required and not found in the argument list, use this value.

descr

Description for this option, for help text.

group

Option group to add this option to.

hidden

If set to true then this option will not be present in auto-generated help.

name

Name for new definition, used for identification.

required

Is this trailing argument required? Defaults to true.

validate

The function that validates the parsed value.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def opt[A](name: String, short: Char, descr: String, default: => Option[A], validate: A => Boolean, required: Boolean, argName: String, hidden: Boolean, noshort: Boolean, group: ScallopOptionGroup)(implicit conv: ValueConverter[A]): ScallopOption[A]

Add a new simple option definition to this config.

Add a new simple option definition to this config.

Value parameters

argName

The name for this option argument, as it will appear in help. Defaults to "arg".

conv

The converter for this option. Usually found implicitly.

default

Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).

descr

Description for the option. Will be printed in help message, carefully formatted to the output width (80 characters by default).

group

Option group to add this option to.

hidden

Hides description of this option from help (this can be useful for debugging options).

name

Name for new option, used as long option name in parsing, and for option identification.

noshort

If set to true, then this option does not have any short name.

required

Is this option required? Defaults to false.

short

By default, the first character of option name is used for short option name. You can override it by specifying the required character (short = 'c').

validate

The function that validates the parsed value.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def printHelp(): Unit

Prints help message (with version, banner, option usage and footer) to stdout.

Prints help message (with version, banner, option usage and footer) to stdout.

Attributes

Inherited from:
ScallopConfBase
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def props[A](name: Char, descr: String, keyName: String, valueName: String, hidden: Boolean, group: ScallopOptionGroup)(implicit conv: ValueConverter[Map[String, A]]): LazyMap[String, A]

Add new property option definition to this config object.

Add new property option definition to this config object.

This option will parse arguments like -Dkey=value or -D key1=value1 key2=value2.

Value parameters

conv

The converter for this option. Usually found implicitly.

descr

Description for this property option, for help description.

group

Option group to add this option to.

hidden

If set to true, then this option will be hidden from generated help output.

keyName

Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".

name

Character that will be used as prefix for property arguments.

valueName

Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def propsLong[A](name: String, descr: String, keyName: String, valueName: String, hidden: Boolean, group: ScallopOptionGroup)(implicit conv: ValueConverter[Map[String, A]]): LazyMap[String, A]

Add new property option definition to this config object.

Add new property option definition to this config object.

This option will parse arguments like --Props key1=value1 key2=value2.

Value parameters

conv

The converter for this option. Usually found implicitly.

descr

Description for this property option, for help description.

group

Option group to add this option to.

hidden

If set to true, then this option will be hidden from generated help output.

keyName

Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".

name

Name for new option, used as long option name in parsing, and for option identification.

valueName

Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def requireAtLeastOne(list: ScallopOptionBase*): Unit

Add a check that at least one of the options is supplied.

Add a check that at least one of the options is supplied.

Value parameters

list

list of options (at least one must be present)

Attributes

Inherited from:
ScallopConfBase
def requireOne(list: ScallopOptionBase*): Unit

Add a check that at one and only one option in the list is supplied.

Add a check that at one and only one option in the list is supplied.

Value parameters

list

list of conflicting options (exactly one must be present)

Attributes

Inherited from:
ScallopConfBase
def requireSubcommand(): Unit

Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).

Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).

Attributes

Inherited from:
ScallopConfBase
def shortSubcommandsHelp(enable: Boolean): Unit

If set to true, do not output subcommand options in the help output for the main program (only output short subcommand description in such cases). Full help for subcommand options can still be accessed via program subcommand-name --help.

If set to true, do not output subcommand options in the help output for the main program (only output short subcommand description in such cases). Full help for subcommand options can still be accessed via program subcommand-name --help.

Value parameters

enable

enable short format for subcommand help

Attributes

Inherited from:
ScallopConfBase
def subcommand: Option[ScallopConfBase]

Retrieves the choosen subcommand.

Retrieves the choosen subcommand.

Attributes

Inherited from:
ScallopConfBase
def subcommands: List[ScallopConfBase]

Retrieves the list of the chosen nested subcommands.

Retrieves the list of the chosen nested subcommands.

Attributes

Inherited from:
ScallopConfBase
def summary: String

Get summary of current parser state.

Get summary of current parser state.

Attributes

Returns

a list of all options in the builder, and corresponding values for them.

Inherited from:
ScallopConfBase
def tally(name: String, short: Char, descr: String, hidden: Boolean, noshort: Boolean, group: ScallopOptionGroup): ScallopOption[Int]

Add a new tally option definition to this config.

Add a new tally option definition to this config.

Tally options count how many times the option was provided on the command line. E.g., -vvv will be countet as 3.

Value parameters

descr

Description for this option, for help description.

group

Option group to add this option to.

hidden

If set to true, then this option will be hidden from generated help output.

name

Name for new option, used as long option name in parsing, and for option identification.

noshort

If set to true, then this option does not have any short name.

short

Overload the char that will be used as short option name. Defaults to first character of the name.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def toggle(name: String, default: => Option[Boolean], short: Char, noshort: Boolean, prefix: String, descrYes: String, descrNo: String, required: Boolean, hidden: Boolean, group: ScallopOptionGroup): ScallopOption[Boolean]

Add new toggle option definition to this config, and get a holder for it's value.

Add new toggle option definition to this config, and get a holder for it's value.

Toggle options are just glorified flag options. For example, if you create a toggle option with name "verbose", it will be invocable in three ways - "--verbose", "--noverbose", "-v".

Value parameters

default

default value for this option

descrNo

Description for negative variant of this option.

descrYes

Description for positive variant of this option.

group

Option group to add this option to.

hidden

If set to true, then this option will not be present in auto-generated help.

name

Name of this option

noshort

If set to true, then this option will not have any short name.

prefix

Prefix to name of the option, that will be used for "negative" version of the option.

required

Is this option required? Defaults to false.

short

Overload the char that will be used as short option name. Defaults to first character of the name.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def trailArg[A](name: String, descr: String, validate: A => Boolean, required: Boolean, default: => Option[A], hidden: Boolean, group: ScallopOptionGroup)(implicit conv: ValueConverter[A]): ScallopOption[A]

Add new trailing argument definition to this config.

Add new trailing argument definition to this config.

Value parameters

conv

The converter for this option. Usually found implicitly.

default

If this argument is not required and not found in the argument list, use this value.

descr

Description for this option, for help text.

group

Option group to add this option to.

hidden

If set to true then this option will not be present in auto-generated help.

name

Name for new definition, used for identification.

required

Is this trailing argument required? Defaults to true.

validate

The function that validates the parsed value.

Attributes

Returns

ScallopOption, container for the parsed option value.

Inherited from:
ScallopConfBase
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21], o22: ScallopOption[A22])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7, A8](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8])(fn: (A1, A2, A3, A4, A5, A6, A7, A8) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (A1, A2, A3, A4, A5, A6, A7) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (A1, A2, A3, A4, A5, A6) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (A1, A2, A3, A4, A5) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (A1, A2, A3, A4) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (A1, A2, A3) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (A1, A2) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validate[A1](o1: ScallopOption[A1])(fn: A1 => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateFileDoesNotExist(fileOption: ScallopOption[File]): Unit

Validate that file does not exists.

Validate that file does not exists.

Attributes

Inherited from:
ScallopConfBase
def validateFileExists(fileOption: ScallopOption[File]): Unit

Validate that file exists.

Validate that file exists.

Attributes

Inherited from:
ScallopConfBase
def validateFileIsDirectory(fileOption: ScallopOption[File]): Unit

Validate that file argument is directory.

Validate that file argument is directory.

Attributes

Inherited from:
ScallopConfBase
def validateFileIsFile(fileOption: ScallopOption[File]): Unit

Validate that file is not a directory.

Validate that file is not a directory.

Attributes

Inherited from:
ScallopConfBase
def validateFilesDoNotExist(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option do not exist.

Validate that all the files in the arguments to multi-arg option do not exist.

Attributes

Inherited from:
ScallopConfBase
def validateFilesExist(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option exist.

Validate that all the files in the arguments to multi-arg option exist.

Attributes

Inherited from:
ScallopConfBase
def validateFilesIsDirectory(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option are directories.

Validate that all the files in the arguments to multi-arg option are directories.

Attributes

Inherited from:
ScallopConfBase
def validateFilesIsFile(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option are not directories.

Validate that all the files in the arguments to multi-arg option are not directories.

Attributes

Inherited from:
ScallopConfBase
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21], o22: ScallopOption[A22])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20], Option[A21], Option[A22]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20], Option[A21]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (Option[A1], Option[A2], Option[A3], Option[A4]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (Option[A1], Option[A2], Option[A3]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (Option[A1], Option[A2]) => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validateOpt[A1](o1: ScallopOption[A1])(fn: Option[A1] => Either[String, Unit]): Unit

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Value parameters

fn

Validation function. In case of error, it should return Left with the error message.

Attributes

Inherited from:
ScallopConfValidations
def validatePathDoesNotExist(pathOption: ScallopOption[Path]): Unit

Validate that path does not point to the existing file.

Validate that path does not point to the existing file.

Attributes

Inherited from:
ScallopConfBase
def validatePathExists(pathOption: ScallopOption[Path]): Unit

Validate that path points to the existing file.

Validate that path points to the existing file.

Attributes

Inherited from:
ScallopConfBase
def validatePathIsDirectory(pathOption: ScallopOption[Path]): Unit

Validate that path points to a directory.

Validate that path points to a directory.

Attributes

Inherited from:
ScallopConfBase
def validatePathIsFile(pathOption: ScallopOption[Path]): Unit

Validate that path points to a file (not directory).

Validate that path points to a file (not directory).

Attributes

Inherited from:
ScallopConfBase
def validatePathsDoesNotExist(pathsOption: ScallopOption[List[Path]]): Unit

Validate that path target does not exist.

Validate that path target does not exist.

Attributes

Inherited from:
ScallopConfBase
def validatePathsExists(pathsOption: ScallopOption[List[Path]]): Unit

Validate that path target exists.

Validate that path target exists.

Attributes

Inherited from:
ScallopConfBase
def validatePathsIsDirectory(pathsOption: ScallopOption[List[Path]]): Unit

Validate that paths targets exist.

Validate that paths targets exist.

Attributes

Inherited from:
ScallopConfBase
def validatePathsIsFile(pathsOption: ScallopOption[List[Path]]): Unit

Validate that all paths targets are files (not directories).

Validate that all paths targets are files (not directories).

Attributes

Inherited from:
ScallopConfBase
def verify(): Unit

Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.

Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.

Attributes

Inherited from:
ScallopConfBase
def version(v: String): Unit

Add a version string to option builder.

Add a version string to option builder.

Value parameters

v

Version string.

Attributes

Inherited from:
ScallopConfBase

Deprecated and Inherited methods

def mainOptions_=(newMainOptions: => Seq[ScallopOption[_]]): Unit

Set options, that are to be printed first in the help printout

Set options, that are to be printed first in the help printout

Attributes

Deprecated
[Since version Scallop 4.0.0]
Inherited from:
ScallopConfBase

Inherited fields

val args: Seq[String]

Attributes

Inherited from:
ScallopConfBase
var builder: Scallop

Internal immutable builder for options setup.

Internal immutable builder for options setup.

Attributes

Inherited from:
ScallopConfBase
var errorMessageHandler: String => Unit

This function is called with the error message when ScallopException occurs. By default, this function prints message (prefixed by printedName) to stderr, coloring the output if possible, then calls exitHandler(1).

This function is called with the error message when ScallopException occurs. By default, this function prints message (prefixed by printedName) to stderr, coloring the output if possible, then calls exitHandler(1).

Update this variable with another function if you need to change that behavior.

Attributes

Inherited from:
ScallopConfBase
var exitHandler: Int => Unit

This function is called with an exit code when Scallop thinks it's time to terminate. By default this calls sys.exit(exitCode).

This function is called with an exit code when Scallop thinks it's time to terminate. By default this calls sys.exit(exitCode).

Update this variable with another function if you need to change that behavior.

Attributes

Inherited from:
ScallopConfBase
val help: ScallopOption[Boolean]

Attributes

Inherited from:
HelpMode
var printedName: String

This name would be included in output when reporting errors.

This name would be included in output when reporting errors.

Attributes

Inherited from:
ScallopConfBase
var stderrPrintln: String => Unit

This function is called with a string when Scallop needs to output text to stderr. Update this variable if you need to redirect stderr output somewhere else.

This function is called with a string when Scallop needs to output text to stderr. Update this variable if you need to redirect stderr output somewhere else.

Attributes

Inherited from:
ScallopConfBase
var stdoutPrintln: String => Unit

This function is called with a string when Scallop needs to output text to stdout. Update this variable if you need to redirect stdout output somewhere else.

This function is called with a string when Scallop needs to output text to stdout. Update this variable if you need to redirect stdout output somewhere else.

Attributes

Inherited from:
ScallopConfBase
protected var validations: List[() => Either[String, Unit]]

Attributes

Inherited from:
ScallopConfValidations
Generated with